The DOCUMENTOR tool has been written as an enquiry and cross referencing facility over ADK, and as a means to generate text files directly from the ADK definitions. This enables the developer to re-use any help text and commenting that is keyed in during the application definition.

DOCUMENTOR generates two types of output:

Text files for PC based word processors

Source files for AS/400 based word processors

Developers using AS/SET on the AS/400 now have the ability to view ADK definitions without opening them for update.

The enquiry facility over ADK enables a developer to identify an AS/SET definition and all its associates using one screen program.

Documentor has now been modified to enable the user to plug in other tools and utilities enabling greater access to the

The enquiry facility allows the user to view the following ADK elements:

• Field reference definitions
• Where a field is used in database files
• File definitions
• Where a file is used by program
• Where a file is used by data model
• Data model definitions
• Programs using data models
• Program definitions
• Actions For Programs
• Parameters For Programs
• Fields Used
• Data models used
• Individual program documentation (user/technical)
• Repository subroutines
• Validation used
• Program usage
• Actions
• Field usage
• Audit trails
• Fields
• Report Layouts
• Program usage
• Document Profiles

A document profile is a specification for a whole document which includes the following elements:

• Document introduction
• Section details (i.e. chapters)
• Section introductions
• Programs documented within each section

Within the DOCUMENTOR product is the facility to maintain and modify document profiles for each application set allowing the user to merge entered text with details extracted from the repository.

Within DOCUMENTOR users now have the facility to define API's to execute the most used AS/SET functions.

User options allow access to the AS/SET functions such as:

• print definition
• call impact of change
• call change management
• list display/report/batch programs within an application set

Within DOCUMENTOR is a facility to list all associated definitions that can be called via the user options. We have also included in the product all the common AS/SET calls and one or two from the change management product Turnover.

The user options facility also allows interfaces between other tools which may run over the native or the AS/SET elements of your system.

DOCUMENTOR now allows the developer to scan the relevant actions using a PDM style scan facility.

The scan facility allows the developer to produce summary reports of all members scanned as well as detail reports which print particular lines of action diagram where applicable.

*NONE

• Clear list panel and start display on first record in file. Performed only once at start of program.
• Count number of parms passed.
• Protect all parms first, Then if a parm was not passed, unprotect it and reduce parm count.
• If parms are not generated, these fields will be blank.
• Set Key values to parms passed
• Set Reposition values to parms passed
• Set file for list to first record in file
• Fill list Panel

CF01
• Process help requests on function key 1

CF03
• Exit program on function key 3

CF07
• Scroll information backward on function key 7
  • 1. Check for any selected records.
  • 2. Fill panel.

CF08
• Scroll information forward on function key 8
  • 1. Check for selected records.
  • 2. Fill panel.

CF12
• Exit program on function key 12

ROLLDOWN
• Scroll information backward
  • 1. Check for any selected records.
  • 2. Fill panel.

ROLLUP
• Scroll information forwards
  • 1. Check for selected records.
  • 2. Fill Panel.

• Check for any selected records on post-enter.
• Reset reposition flag and check for any selected records.
  • Check for reposition
  • Check field only if not passed as parm.
• If reposition values entered, set key values to reposition values.
• Reset/clear reposition values to parms passed
• Refresh screen if record selected or if reposition was selected.
• Set pointer to file.
• Fill Panel.

• S01BKW SCRN SUB
  • Scroll information backward
  • Clear hidden key arrays used for record retrieval.
  • Save key values in key arrays.
  • Fill any possible work fields in list panel with secondary file fields.
• S01EDT SCRN SUB
  • Process Maintenance List Panel (ML)
    • 1. Check for any selected records
  • Add new record
  • Set key values to header file
  • Update existing record
  • Delete existing record
  • Process any optional action choices.
    • 1. Set key values to hidden key arrays.
    • 2. Retrieve file and any secondary files.
    • 3. Display screen.
  • If the action choice is not one of the allowed values, display error message.
• S01FWD SCRN SUB
  • Scroll information forward
  • Clear Hidden key arrays used for later >record retrieval.
  • Save key information in key arrays.
  • Set any work fields to values in secondary file fields.

CF01

*** Display help

CF12

*** Resume

*** Edit for correct option

Action code
1. Create an new salesman record
2. Amend an existing record
4. Delete an existing record

• F1        - Process help requests on function key 1
• F3        - Exit program on function key 3
• F7        - Scroll information backward on function key 7
• F8        - Scroll information forward on function key 8
• F12      - Exit program on function key 12
• PGUP  - Scroll information backwards
• PGDN  - Scroll information forwards

Data model diagrams can be produced as printed reports from the AS/400, as AS/400 source files or as PC text files which are generated in a specified folder on the AS/400. These files can then be included into any of the popular PC based word processors or AS/400 text editors.

Diagrams for data models can be produced as follows :-

• By the whole repository
• By individual data model

The following example was generated using the ADK training set.

Application Set: SET1
Data Model: OEXXX Order Entry System

Users of AS/SET now have the facility to document all files as follows:-

• By repository
• By data model
• By individual file

The file layouts can be printed as a report, generated as an AS/400 source member or generated as a PC text file. The resulting files can then be included into AS/400 text managers or any of the popular PC based word processors.

File Layout by data model example

Application Set: SET1
Data Model: OEXXX
File: *ALL

Physical

Logicals based on file:

*NONE

Physical

Unique

Logicals based on file:

*NONE

Physical

Unique

Logicals based on file:

*NONE

Physical

Logicals based on file:

*NONE

• Documentation can be automatically generated and merged with keyed text
• Repository action subroutines can be cross referenced
• An enquiry only facility is available this allows a compiling program to be browsed
• PDM type scan over all actions for a definition or all definitions
• Cross reference report which runs over all application sets
• global application sets and referring application sets are supported
• Cross reference for audit trails
• User defined action codes allow interfaces for many other utilities
• Technical documentation can be easily generated into the following forms
• PC text files
• AS/400 reports
• AS/400 Source members

DOCUMENTOR will save the developer valuable time in the following areas:

• Automatically generating required documentation
• Quicker , easier access to definitions with browse only option
• Comprehensive cross referencing capabilities to identify definitions and associates