Creating and Editing a Work List (SAP Library - BC Documentation of System Objects)

Creating and Editing a Work List

Using a work list for maintaining documentation enables you to:

work on a larger set of documents of various document classes in context. You can define that set by specifying various selection criteria.

maintain short texts for the objects in your work list by double-clicking on the short text displayed in the work list overview. This will get you to the maintenance transaction for the respective object.

use the following print output options:

print a list of the documents or objects selected with administrative information
Documentation in edited form with INCLUDES
Documentation with editor formatting and expanded links.

You can use the following selection criteria when creating a work list:

Editing Status

Objects not requiring documentation
Undocumented objects
Raw version documents
Final version documents
Active documents

Environment for Work List

Development class
Transaction
Program
Table

Document Class

You can choose document classes form the list available for end user documentation.

Creating a Work List

In the initial screen of the documentation maintenance transaction, select the menu function Utilities ® Work list.

Select one or more editing statuses (editing status "objects not requiring documentation" can only be selected on its own).

Under "Environment for work list", select an environment.

Press ENTER or click on the OK pushbutton in the standard toolbar. A dialog box appears in which you can enter the name of the selected environment.

Specify the name of the environment (development class, program, etc.) and select Continue. A further dialog box for selecting document classes appears.

Select the document classes you require and then Continue. The desired work list is generated.

Save the work list you have generated with menu function Work list ® Save.

Note

With large development classes containing many objects the generation of a work list may take a while. Therefore, if you want to work on a work list repeatedly you should save it.

Using an Existing Work List

In the initial screen of the documentation maintenance transaction, select Utilities ® Work list to branch to the initial screen for a work list.

Select one or more editing statuses (editing status Objects not requiring documentation can only be selected on its own).

Select the Work list option under the heading "Environment for work list".

Press ENTER or click on the OK pushbutton in the standard toolbar.

A dialog box appears. Enter here the name of the work list you wish to use and select Continue.

You can also make a generic entry using the wildcard * to create a list of saved work lists. You can then select a work list of your choice for editing or deletion.