Administration

#### Search Results

Search

# Administration

This function is used to maintain Object Handler Workplans.

For information on Workplans and the syntax that applies, refer to the sections Workplans and Direct Commands.

This section describes the options provided on the Administration screen. Instructions for modifying a Workplan are provided in List the Available Workplans in the Workplan Library.

- List the Available Workplans in the Workplan Library

- Create a New Workplan

- Change the Workplan Library

- Change the Report Library

## List the Available Workplans in the Workplan Library

This function is used to list all Workplans contained in the Workplan library and to select a Workplan for further processing such as editing or executing the Workplan.

To list Workplans

- On the Administration screen, select List the available Workplans in the Workplan library or choose PF4 (List).

  The List Workplans screen appears with a list of all Workplans contained in the Workplan library.

  If the Natural object of the type Text is a Workplan, the type of Workplan and the first 50 bytes of the Workplan description are listed. You can choose PF5 to display additional information.

The List Workplans screen is also invoked with the select function, which is provided, for example, on the Unload/Load/Scan Settings screen.

The columns displayed on the List Workplans screen and the commands that can be executed on a Workplan are described in the following section.

- Columns and Commands on the List Workplans screen

### Columns and Commands on the List Workplans screen

The columns and commands provided on the List Workplans screen are explained in the following table.

You can use the input fields below each column heading to start the list from a particular Workplan or filter Workplans. Valid input values are mentioned in the table below.

Column | PF Key | Explanation
--- | --- | ---
Cmd |  |
The following line commands can be entered in the input field next to the Workplan required:
`C` or `CH` | Checks the syntax. Only applies to Workplans of the types PROCEDURE, SELECTION, PARAMETER and OPTION.
`DE` | Deletes the Workplan.
`ED` | Edits the Workplan. You can modify the name of a Workplan or its description in the Save Workplan window described in Saving a Workplan.
`EX` | Executes the Workplan. Only applies to Workplans of the type PROCEDURE.
`L` or `LI` | Lists the Workplan.
`S` or `SE` | Selects the Workplan to be used for the current function. Only applies if the List Workplans screen is invoked with the select function, for example, from the Unload/Load/Scan Settings screen.
Name |  | The name of the Workplan. You can enter a name or a range of names as described in Name in Name, Date and Time Specification.
Type |  |
The type of Workplan such as PROCEDURE. Valid input values are:
`PROCEDURE` or `P`
`SELECTION` or `S`
`LIST` or `L`
`PARAMETER` or `A`
`OPTION` or `O`
`TEXT` or `T`
You can also enter an asterisk (*) for all types, or any combination of the short types, for example `SL`.
Description |  | The description of the Workplan. You can enter a description or a range of descriptions as described in Name in Name, Date and Time Specification.
User ID |  | Only displayed with PF5. The ID of the user who created the Workplan. You can enter a user ID or a range of user IDs as described in Name.
Date |  | Only displayed with PF5. The date when the Workplan was created. You can enter a date or a range of dates as described in Date in Name, Date and Time Specification.
Time |  | Only displayed with PF5. The time when the Workplan was created. You can enter a time or a range of times as described in Time in Name, Date and Time Specification.
| PF4 | Switches from the additional information display (PF5) to the standard display.
| PF5 | Displays additional information: user ID, date and time.

## Create a New Workplan

This function invokes the Create a new Workplan screen where you can specify the type of the new Workplan and the format to be used for editing the Workplan.

If you do not select the Free Format Editing option (field not marked; this is the default setting), for Workplans of the types OPTION, PARAMETER and SELECTION, screens with input fields are provided.

If you select the Free Format Editing option (field marked) or if you create a Workplan of another type, you will obtain a map with an edit area where you can enter the contents of the Workplan; see also Contents of Workplans in the section Workplans.

For alternative direct command that can be used to set free format editing on and off, see the command `SET` in Commands for Navigation and Special Functions in the section Direct Commands.

This section covers the following topics:

- Creating a PROCEDURE Workplan

- Creating a LIST Workplan

- Saving a Workplan

### Creating a PROCEDURE Workplan

You can create a Workplan of the type PROCEDURE from the command generated for the current Object Handler function.

To create a PROCEDURE Workplan from a generated command

1. Execute the function you want to use for the Workplan with an Object Handler wizard until the command generated for the function to be executed is displayed on the screen.

   Or:
   In advanced-user mode, activate the display of the generated command by choosing either of the following methods:

   - Enter the following Object Handler command:

         SET ADVANCEDCMD ON

     Or:
     In the Object Handler profile, set the parameter `Display-Cmd-in-Advanced-Mode` to `Y` (Yes). For details, see Profile Settings.

   - Execute the function you want to use for the Workplan until the command generated for the function to be executed is displayed on the screen.

2. Choose PF5 (Save).

   The Save Workplan window appears.

3. Enter name and description of the new Workplan and choose ENTER.

   The Workplan is saved as a PROCEDURE Workplan in the Workplan library. It contains the command generated for the current function.

### Creating a LIST Workplan

For details on creating a Workplan of the type LIST, refer to the section Object List - LIST Workplan.

### Saving a Workplan

To save a Workplan

1. When you have finished editing a Workplan, in the Command line, enter the following command:

       SAVE

   Or:
   Choose PF5 (Save).

   The Save Workplan window appears.

2. Enter or modify name and description of the Workplan and choose ENTER.

   The Workplan is saved under the specified name in the Workplan library.

## Change the Workplan Library

This function is used to change the Workplan library. All Workplans must be stored in a Workplan library.

Note
You can also set the default library for Workplans by specifying the `Workplan-Library` parameter in your Object Handler profile (see Profile Settings).

The Change Workplan Library screen provides the following fields:

Field | Explanation
--- | ---
Library | The name of the Workplan library. Default is the library `WORKPLAN`.
Select library | Displays a list of all Workplan libraries available: see also Select Library. Equivalent PF key: PF4 (SeLib)
DBID/FNR | Specifies the database ID (DBID) and file number (FNR) where the Workplan library is located. If no values are specified, the current FUSER or FNAT system file is used.
Passw./Ciph. | The password and cipher code of the Adabas file where the Workplan library is located.
Store values in profile | Determines whether the values specified for the Workplan library are stored in the Object Handler profile:
`N` | Do not store the specified values. This is the default.
`U` | Store the specified values in the user-specific profile settings.
`G` | Store the specified values in the general profile settings.
See also Profile Settings.

## Change the Report Library

This function is used to change the report library. All reports that are created when the `REPORT` or `NEWREPORT` option is specified in an Object Handler command are stored in the report library. If no report library is specified, the values specified for the Workplan library are used instead.

Tip
You can set the default library for reports by specifying the `Report-Library` parameter in your Object Handler profile (see Profile Parameters in the section Profile Settings).

The Change the Report library function opens the Change Report Library screen which provides the following fields:

Field | Explanation
--- | ---
Library | The name of the report library. Default is the library `WORKPLAN`.
Select library | Displays a list of all libraries available: see also Select Library. Equivalent PF key: PF4 (SeLib)
DBID/FNR | Specifies the database ID (DBID) and file number (FNR) where the report library is located. If no values are specified, the current FUSER or FNAT system file is used.
Passw./Ciph. | The password and cipher code of the Adabas file where the report library is located.
Store values in profile | Determines whether the values specified for the report library are stored in the Object Handler profile:
`N` | Do not store the specified values. This is the default.
`U` | Store the specified values in the user-specific profile settings.
`G` | Store the specified values in the general profile settings.
See also Profile Settings.

### On this page

- List the Available Workplans in the Workplan Library
- Create a New Workplan
- Change the Workplan Library
- Change the Report Library