The utility SYSAPI is used to locate and test Application Programming Interfaces (APIs) provided by Natural add-on products such as Entire Output Management.
The API of a Natural add-on product is a Natural subprogram (cataloged object) that is used for accessing and possibly modifying data or performing services that are specific to an add-on product or a subcomponent.
The API of a Natural add-on product is supplied in the Natural library and/or system file provided for objects that are specific to a particular Natural add-on product. For instructions on using the API of a Natural add-on product, refer to the documentation of the respective add-on product.
For each API of a Natural add-on product, the utility SYSAPI provides a functional description, one example program and API-specific keywords.
The SYSAPI Utility - APIs of Natural Add-On Products documentation covers the following topics:
Natural User Exits - Operations documentation
SYSEXT - Natural Application Programming Interfaces - Utilities documentation
The appropriate Natural add-on product must be installed at your site.
The version of the Natural add-on product installed must support the SYSAPI utility features.
This section provides instructions for invoking and terminating the SYSAPI utility.
To invoke the SYSAPI utility
Enter the following system command:
SYSAPI
The SYSAPI menu appears which lists one or more Natural add-on products, each followed by one or more associated API groups.
Each API group represents a particular API feature provided for the Natural add-on product. An API group contains all example programs that relate to this feature.
You can select an API group for displaying all example programs that belong to this group as described in Listing API Example Programs.
Note:
In the Command line of any SYSAPI
utility screen, you can enter any Natural system command.
To terminate SYSAPI
Press PF3 or PF12.
You can obtain a list of all example programs available for a selected API group. You can shorten this list by specifying the name of an API example program or a particular range of names.
To list all API example programs
In the SYSAPI menu, in the input field next to the API group desired, enter any character or use cursor selection.
The SYSAPI list screen appears for the selected API group. The screen contains the Example column with the names of the API example programs, and the Function column with a brief functional description of the corresponding API.
The list is sorted in alphabetical order by name of example program. If required, press PF8 to scroll down one page in the list. Press PF6 to go to the beginning of the list.
To list a single example program or a particular range
On the SYSAPI list screen, in the Example input
field, enter any of the input values listed in the table below where
value is any combination of one or more
characters:
| Input | Example Programs Selected |
|---|---|
value
|
The example program that matches
value.
|
*
|
All example programs. This is the default setting. |
|
|
All example programs that match
asterisk ( Examples:
|
Press ENTER.
The SYSAPI list screen displays the specified example program(s).
Keywords help you find the APIs relevant to your current task. You can use the keyword search function to list all keywords relevant to the selected API group or list API example programs by keyword(s).
To list all keywords relevant to an API group
In the Command line, enter
KEYWORDS.
Or:
Press PF5.
The List Keywords window appears. It contains all keywords in alphabetical order that are specific to the API group.
If required, press PF8 to scroll down the list of keywords or press PF6 to go to the beginning of the list.
To list example programs by keyword
On the SYSAPI list screen, in one or more of the input fields next to Keywords, enter a valid keyword. If required, press PF10 to clear the contents of all Keywords fields.
Or:
From the List Keywords window, choose a maximum
of three keywords:
Next to the keyword desired, enter any character to mark the keyword for selection and press ENTER.
The keywords selected are displayed in the List Keywords window under Selected keywords.
If required, press PF10 to clear the keywords listed under Selected keywords and repeat the keyword selection.
Press PF3 to confirm the keyword selection.
The SYSAPI list screen appears with the selected keywords entered in the Keywords fields. Additionally, the example programs that contain the specified keywords are listed on the screen.
If required, in the And/Or field, enter an
A or an O (the default setting is A) to
combine keywords with a logical condition.
Press ENTER to perform the keyword search.
The example programs that contain the specified keyword(s) are listed on the screen.
The SYSAPI utility provides line commands that can be used to display,
modify or execute an API example program. You enter a line command on the
SYSAPI list screen, in the Cmd column next to the example
program required. For a list of valid line commands, enter a question mark
(?) in this column.
The following line commands are available on the SYSAPI list screen:
| Line Command | Function |
|---|---|
L
|
List source code. |
E
|
Edit source code. |
X
|
Execute program. |
