Commands

#### Search Results

Search

# Commands

- General Information on Direct Commands

- Descriptions of Direct Commands

Note
With Entire Output Management's character-based user interface, all direct commands are available. With its graphical user interface (NGC), some commands are not available. If a command is not available with NGC, this is indicated by a note at the end of the command description concerned.

## General Information on Direct Commands

You can use direct commands to invoke screens directly, without going through the functional screen hierarchy.

### Entering a Direct Command

You enter a direct command in the command line of a screen:

    Command => ___________________________________________________________________

### Command Components

Most direct commands consist of the following components, which you specify in the following order:

    command-name object-type object-name

The `object-type` can be:

`object-type` | Object Type
--- | ---
`ABUNDLES` | Active bundles
`AREPORTS` | Active reports
`BUNDLES` | Bundles
`CALENDARS` | Calendars
`FOLDER` | Folders
`LISTS` | Distribution lists
`PHYSICAL` | Physical printers
`PRINTERS` | Logical printers
`REPORTS` | Reports
`USERS` | Users

These are the most common types. With some commands, other types can be specified, as explained with each command.

With several commands, you can specify an `object-name` (or `object-ID`) after the `object-type`, as shown in the syntax of each command.

For example, to display a bundle named "DEP-PROD", you enter the command: `DISPLAY BUNDLES DEP-PROD`.

Command elements which are optional are indicated by square brackets `[ ]`.

### Abbreviating a Command

The `command-name` and `object-type` can be abbreviated. The shortest possible abbreviation is indicated by underlining. For each `command-name` this is shown in the syntax of each command, and for each `object-type` in the list above.

For example, you can abbreviate the command

    LIST REPORTS

to

    LI REP

### Incomplete Commands

If you enter an incomplete command, you will either receive an error message asking you to specify the missing components, or a selection window in which you can enter the missing specifications.

## Descriptions of Direct Commands

The following direct commands are available:

- ADD

- ADMIN

- CLOSE

- CONTENTS BUNDLES

- COPY

- COPY SECURITY

- DELETE

- DISPLAY

- DLOG

- EXIT

- EXPORT

- FIN

- FLIP

- FLUSH

- FOLLOW

- HELP

- IXREF

- LIST

- LOGON

- LOGON APPLICATION

- MASSDEL

- MENU

- MODIFY

- PROFILE

- QUIT

- SELECT

- SET

- SHUTDOWN

- SPF

- START

- TECH

- TRACE

- TRANSFER

- VTAM

- XREF

### ADD

    ADD [object-type]

This command is used to add object definitions for the following object types:

`object-type`
`BUNDLES`
`CALENDARS`
`FOLDER`
`LISTS` (= distribution lists)
`PHYSICAL` (= physical printers)
`PRINTERS` (= logical printers)
`REPORTS`
`USERS`

On most Maintenance screens, you can invoke the `ADD` command by pressing PF2.

### ADMIN

    ADMIN

This command displays the System Administration menu.

It corresponds to the command `MENU ADMIN`.

Note:
Command not available with NGC.

### CLOSE

    CLOSE PHYSICAL [printer-name]

This command stops a physical printer.

To stop a whole group of physical printers, you specify a `printer-name` with an asterisk (*). For example, to stop a all printers whose names begin with "DR", you would enter: `CL PH DR*`

### CONTENTS BUNDLES

    CONTENTS BUNDLES [bundle-name]

This command lists the contents of the specified bundle.

Note:
Command not available with NGC.

### COPY

    COPY [object-type [object-name]]

This command is used to copy object definitions of the following object types:

`object-type`
`BUNDLES`
`PHYSICAL` (= physical printers)
`PRINTERS` (= logical printers)
`REPORTS`
`USERS`

### COPY SECURITY

    COPY SECURITY

This command is used to copy Natural Security user definitions.

Note:
Command only available with NGC.

### DELETE

    DELETE [object-type [object-name]]

This command is used to delete object definitions of the object types:

`object-type` | Comment
--- | ---
`BUNDLES` | -
`CALENDARS` | To delete a calendar, you have to specify the calendar name and the year to which the calendar applies. For example: `DE CA TICAL 2014`.
`LISTS` (= distribution lists) | -
`PHYSICAL` (= physical printers) | -
`PRINTERS` (= logical printers) | -
`REPORTS` | -
`USERS` | -

### DISPLAY

    DISPLAY [object-type [object-name]]

This command is used to display object definitions of the following object types:

`object-type` | Comment
--- | ---
`BUNDLES` | -
`CALENDARS` | To display a calendar, you have to specify the calendar name and the year to which the calendar applies. For example: `DI CA TICAL 2014`.
`LISTS` (= distribution lists) | -
`PHYSICAL` (= physical printers) | -
`PRINTERS` (= logical printers) | -
`PROFILE` (= user profiles) | Command option not available with NGC.
`REPORTS` | -
`USERS` | -

### DLOG

    DLOG [object-type [user-ID]]

This command is used to display log information for the following object types:

`object-type`
`MONITOR`
`PRINTOUTS`
`USER` (= user activity)

If you do not specify an `object-type`, `MONITOR` will be used.

With `USER`, you can specify the `user-ID` of the user for whom you wish to get log information.

Note:
Command not available with NGC.

### EXIT

    EXIT

This command returns to the previous screen. When invoked from the Main Menu, this command terminates your Entire Output Management session.

It corresponds to the function of PF3.

Note:
Command not available with NGC.

### EXPORT

    EXPORT

This command exports Entire Output Management objects to an XML file for the transfer to another environment. See Exporting Objects in the System Administration documentation for details.

Note:
Command not available with NGC.

### FIN

    FIN

This command terminates the Natural session.

Note:
Command not available with NGC.

### FLIP

    FLIP

This command switches the display of the PF-key lines.

It corresponds to the function of PF4. See PF Keys in the User's Guide.

Note:
Command not available with NGC.

### FLUSH

    FLUSH BUNDLE [bundle-name]

This command prints a bundle immediately.

Note:
Command not available with NGC.

### FOLLOW

    FOLLOW

This command displays the time the Monitor was last activated.

Note:
Command not available with NGC.

### HELP

    HELP

This command displays a Help screen related to the current screen.

It corresponds to the function of PF1.

Note:
Command not available with NGC.

### IXREF

    IXREF

This command is only available to system administrators. It allows a cross-reference list of report identification criteria for the given identification type (such as job name, writer and so on) to be displayed or printed to Printer 1.

Note:
Command not available with NGC.

### LIST

    LIST [object-type [object-name [parameter]]]

This command is used to list object definitions of the following object types:

`object-type` | Comment
--- | ---
`ABUNDLES` (= active bundles) | An `object-name` cannot be specified.
`ARCHIVE` (= archive data sets) | An `object-name` cannot be specified.
`AREPORTS` (= active reports) | An `object-name` cannot be specified.
`BUNDLES` | -
`CALENDARS` | -
`LISTS` (= distribution lists) | -
`PHYSICAL` (= physical printers) | -
`PRINTERS` (= logical printers) | The `VTAM-ID` can be specified as additional `parameter`.
`PRINTOUTS` (= queued printouts) | An `object-name` cannot be specified.
`REPORTS` | The `job-name` and `writer` can be specified as additional `parameters`.
`USERS` | -

### LOGON

    LOGON user-ID password

This command allows you to log on to Entire Output Management under another user ID.

Note:
Command not available with NGC.

### LOGON APPLICATION

    LOGON APPLICATION [application-name][command]

This command allows you to log on another Natural application.

Note:
Command not available with NGC.

### MASSDEL

    MASSDEL [object-type [object-name]]

This command is only available to system administrators. It is used for the mass deletion of the following objects:

`object-type`
`ABUNDLES` (= active bundles)
`AREPORTS` (= active reports)
`BUNDLES`
`REPORTS`

As `object-name` you can specify a "mask" containing the wildcard characters asterisk (*) and question mark (?). This allows you to selectively delete objects whose names contain certain characters. The question mark represents 1 character; the asterisk represents any number of characters (0 to 50).

#### Examples:

To delete all bundles ... | ... you issue the command: | Bundles deleted would include:
--- | --- | ---
... whose names begin with "ABC" ... | `MASSDEL BU ABC*` | `ABC, ABCD, ABC262`
... whose names contain the character string "ABC" ... | `MASSDEL BU *ABC*` | `ABC, ABCD, XABC, 123ABC`
... whose names start with "A" and end with "BUN" ... | `MASSDEL BU A*BUN` | `ABUN, ABBUN, ABCBUN`
... whose names start with "A" and end with "BUN-", followed by any two characters ... | `MASSDEL BU A*BUN-??` | `ABCBUN-21, ABCD-BUN-GL`
... whose names start with any four characters, followed by "-BUN" ... | `MASSDEL BU ????-BUN` | `1234-BUN, ABCD-BUN`

When you issue the command, a menu will be displayed in which you can specify additional options:

- Refresh count - The increment for the counter of objects being deleted as shown on the screen. By default, the counter is incremented in steps of 1000.

- Log deletions - Log the individual deleted objects in the User log and Monitor log (Y/N). Summary information on the deletion is always written to the Monitor log, regardless of this option.

- If object type AR, even archived - When deleting active reports, also delete the archived ones (Y/N).

After specifying the objects to be deleted and selecting the desired options, you have to press PF5 to actually perform the deletion.

Note
When you delete an active report, it will be deleted for all users.

### MENU

    MENU [menu-name]

This command is used to invoke one of the following menu screens:

`menu-name` | Menu Invoked | Comment
--- | --- | ---
`AREPORTS` | Active Reports menu | -
`ADMIN` | Administration menu | This menu can also be invoked with the command `ADMIN`.
`DEFAULTS` | Default Definition menu | -
`MAIN` | Main Menu | This menu can also be invoked by pressing PF12.
`MONITOR` | Monitor Management menu | -

Note:
Command not available with NGC.

### MODIFY

    MODIFY [object-type [object-name]]

This command is used to modify object definitions of the following object types:

`object-type` | Comment
--- | ---
`BUNDLES` | -
`CALENDARS` | To modify a calendar, you have to specify the calendar name and the year to which the calendar applies, For example: `MO CA TICAL 2012`.
`LISTS` (= distribution lists) | -
`MONITOR` | Not available with NGC.
`PHYSICAL` (= physical printers) | -
`PRINTERS` (= logical printers) | -
`PROFILE` (= user profile) | Not available with NGC.
`REPORTS` | -
`USERS` | -

### PROFILE

    PROFILE

This command displays the current user ID and name and allows you to set the default printer.

Note:
Command not available with NGC.

### QUIT

    QUIT

This command ends your Entire Output Management session.

Note:
Command not available with NGC.

### SELECT

    SELECT [object-type]

This command is used to set and clear selection criteria for the following types of objects:

`object-type`
`ABUNDLES` (= active bundles)
`AREPORTS` (= active reports)
`BUNDLES`
`CALENDARS`
`FOLDER`
`LISTS` (= distribution lists)
`PHYSICAL` (= physical printers)
`PRINTERS` (= logical printers)
`REPORTS`
`USERS`

Note:
Command not available with NGC.

### SET

    SET [option [value]]

This command is used to set the following Entire Output Management session options:

`option` | `value` | Explanation
--- | --- | ---
`COMMIT` | `ON` or `OFF` | Determines how object modifications are committed: `SET COMMIT OFF` - When you have modified an object and exit without pressing PF5 (Do) to commit your changes, a window is displayed requesting you to confirm the modification. This is the default. `SET COMMIT ON` - No additional confirmation window is displayed, the modifications are automatically committed when you press ENTER or PF5.
`CONFIRM` | `ON` or `OFF` | Determines whether delete operations are performed with or without additional confirmation: `SET CONFIRM ON` - When you delete an object, a window is displayed requesting you to confirm the deletion by typing the object name. This is the default. `SET CONFIRM OFF` - When you delete an object, it is deleted immediately without your being prompted for a confirmation.
`LANGUAGE` | `1` or `2` | Determines in which language the user interface of Entire Output Management is displayed: `SET LANGUAGE 1` - User interface in English. `SET LANGUAGE 2` - User interface in German.

Note:
Command not available with NGC.

### SHUTDOWN

    SHUTDOWN

This command closes the Monitor.

When you invoke this command, a window opens in which you can confirm Monitor shutdown by entering `SHUTDOWN`. "Shutdown in progress" appears in the Status field. This means that the Monitor has not yet detected the close because it is in wait status. The next time the Monitor is active, it closes normally and "Closed" appears in the Status field.

To resume without closing the Monitor, press PF3 (Exit) instead of entering `SHUTDOWN`.

### SPF

    SPF

This command invokes Natural ISPF (if installed).

Note:
Command not available with NGC.

### START

    START [object-type [object-name]]

This command is used to start the following:

`object-type` | Task/Object Started | Comment
--- | --- | ---
`ARCHIVE` or `ARCHIVING` | Archiving task | When you issue this command, a window is displayed, requesting you to specify the starting time of the task.
`CONDENSE` | Condense task | -
`MONITOR` | Monitor | -
`PHYSICAL` | Physical printer | -
`REVIVER` or `REVIVING` | Reviving task | When you issue this command, a window is displayed, requesting you to specify the starting time of the task.

An `object-name` can only be specified with `PHYSICAL`.

To start a whole group of physical printers, you can specify `object-name` with an asterisk (*).

### TECH

    TECH

This command displays system-relevant technical information.

### TRACE

    TRACE

This command displays the Trace Report Processing screen.

For more information, see Tracing Report Processing in the User's Guide.

Note:
Command not available with NGC.

### TRANSFER

    TRANSFER [object-type]

This command is used to copy the following objects to another database:

`object-type`
`BUNDLES`
`CALENDARS`
`LISTS` (= distribution lists)
`PRINTERS` (= logical printers)
`PHYSICAL` (= physical printers)
`REPORTS`
`USERS`

For more information, see Transferring Objects in the System Administration documentation.

Note:
Command not available with NGC.

### VTAM

    VTAM

This command displays the NOMVPRNT Management screen.

Note:
Command not available with NGC.

### XREF

    XREF

This command is only available for system administrators. It allows a cross-reference list of separation or printer exit usage or report or bundle separator page usage to be displayed or printed on Printer 1.

Note:
Command not available with NGC.