SYSEXT Utility - Natural Application Programming Interfaces

#### Search Results

Search

# SYSEXT Utility - Natural Application Programming Interfaces

The utility SYSEXT is used to locate and test Natural Application Programming Interfaces (APIs) contained in the current system library SYSEXT either in a local Windows environment or in a remote environment located on a Windows, a Linux, or a z/OS platform.

A Natural API is a Natural subprogram (cataloged object) that is used for accessing and possibly modifying data or performing services that are not accessible by Natural statements. Natural APIs refer to Natural, a subcomponent or a subproduct.

The SYSEXT Utility - Natural Application Programming Interfaces documentation covers the following topics:

- SYSEXT Prerequisites

- Introduction to SYSEXT

- Invoking and Terminating SYSEXT

- SYSEXT Tree View Items

- Performing SYSEXT Utility Functions

- Interface Versions

- Reserved Keywords

- Using a Natural API

- List of Natural APIs

#### Related Topics:

- Application Programming Interfaces - Natural Security documentation

- SYSAPI - APIs of Natural Add-on Products - Utilities documentation

## SYSEXT Prerequisites

The Enable Plug-ins option must be selected. This option is selected by default. For details, see Workspace Options in the section Setting the Options in the Using Natural Studio documentation.

## Introduction to SYSEXT

For each Natural API, the utility SYSEXT provides a functional description, one example program and API-specific keywords.

The following diagram is an overview of the Natural objects and major features SYSEXT provides:

### Objects Provided for Natural APIs

The types of Natural object typically provided for each Natural API are listed in the following section. Additional objects that might exist for a particular API are not covered.

All API-related objects are contained in the library SYSEXT on the system file FNAT.

In the following table, nnnn denotes the 4-digit number to identify the API as well as the corresponding example program and text object.

Object Name | Explanation
--- | ---
USRnnnnN | The API subprogram (cataloged object) that performs the designated function.
USRnnnnP | An example program (source object) that can be used to test the effect of the API. The example program invokes the corresponding subprogram USRnnnnN.
USRnnnnT | A text object that contains a description of the corresponding API. The description comprises purpose, function and calling conventions of the API and relevant keywords, category and interface versions.

For some APIs, copycodes are available which provide functions related to the API. The copycodes are named `USRnnnnX`, where `X` is an identification character (such as "Z", "Y" etc.).

Caution
Do not modify the source objects EXT-XML1 and EXT-XML2. They are required for configuring the SYSEXT utility and intended for internal use only.

## Invoking and Terminating SYSEXT

This section provides instructions for invoking and terminating the SYSEXT utility.

To invoke SYSEXT

- Enter the following system command:

      SYSEXT

  Or:
  From the Tools menu, select Development Tools > Application Programming Interfaces.

  When invoking SYSEXT, the plug-in for the utility SYSEXT is activated and the SYSEXT utility window appears with the root node SYSEXT - Application Programming Interfaces as shown in the example below:

To restart SYSEXT

- If you want to restart SYSEXT during the current Natural session, as an alternative to the start methods mentioned above, from the toolbar, choose the following icon:

  This icon appears after initially invoking SYSEXT, when the plug-in for the utility SYSEXT is activated.

To terminate SYSEXT

- Choose the standard Windows close function.

## SYSEXT Tree View Items

This section describes the nodes and items contained in the tree view of the SYSEXT utility window.

If you expand all tree nodes, the tree looks similar to the example below:

Each Natural API is represented by an API node that contains the example program, description and keywords that relate to this API. The API node name consists of the name of the API subprogram (USRnnnnN) and a brief description of its functional purpose. The nodes are sorted by API names.

The following items are provided in an API node:

Item | Explanation
--- | ---
Keywords | All keywords relevant to the API. See also the functions Select Keyword and List All Keywords in Performing SYSEXT Utility Functions.
Description | A text object (USRnnnnT) that contains a description of the API. The description comprises purpose, function and calling conventions of the API and keywords relevant to the API.
Example Program | An example program (source object USRnnnnP) of how to invoke the API.

## Performing SYSEXT Utility Functions

The SYSEXT utility functions offer a set of operations that can narrow down a search by using keywords.

The operations are available from the context menu of the root node SYSEXT - Application Programming Interfaces.

The following functions can be executed:

- Select Keyword

- List All Keywords

- Refresh

For more information on Natural object operations of the type text or program beyond what is available with SYSEXT (such as List, Open, and Execute functions), see the relevant sections in Using Natural Studio.

### Select Keyword

This function is used to list APIs by keyword.

To list APIs by keyword

1. Select the root node SYSEXT - Application Programming Interfaces, open the context menu and choose Select Keyword or press SHIFT+K.

   The Select Keyword window appears.

2. From the drop-down list box, select a keyword as shown in the example below:

3. Choose the OK button.

   The root node SYSEXT - Application Programming Interfaces with Keyword appears for the selected keyword.

4. Expand the root node.

   The nodes of all APIs to which the specified keyword applies are displayed as shown in the example of keyword `*LANGUAGE` below:

5. To return and display all API nodes (default setting), select the asterisk (`*`).

### List All Keywords

This function is used to list all keywords for the APIs available in the current system environment.

To list all API keywords

1. Select the root node SYSEXT - Application Programming Interfaces, open the context menu and choose List All Keywords or press SHIFT+A.

   The All Keyword window appears as an additional window with the root node SYSEXT - All Keywords of Application Programming Interfaces.

2. Expand the root node.

   A list of all keywords is displayed as shown in the example below:

### Refresh

This function updates API information in the tree view using the data from the objects contained in the current library SYSEXT. The refresh is only required if an API description or a keyword was modified or if a text object was removed.

Note
Do not modify the source objects EXT-XML1 and EXT-XML2. They are required for configuring the SYSEXT utility and intended for internal use only.

To refresh API information

1. Select the root node SYSEXT - Application Programming Interfaces, open the context menu and choose Refresh or press SHIFT+R.

   A Refresh window appears.

   If you access a remote environment on z/OS, you must specify the parameter `SORT` in the map environment settings as indicated below:

   `SORT=(WRKSIZE=50)`

   For details on mapping a server, see Accessing a Remote Development Environment in the documentation Remote Development Using SPoD. For details on `SORT`, refer to the Parameter Reference of Natural for z/OS.

2. Choose the OK button to confirm the refresh or choose Cancel to abort the operation.

## Interface Versions

Interface versions can be seen as a collection of APIs with (almost) the same functionality but with differently extended parameter specifications. Thus, they cover a development cycle to be kept explicit for sake of compatibility (of later versions with earlier versions).

If an API has interface versions, they are displayed in the corresponding text object USRnnnnT. Interface versions are ordered within a list according to the version they belong to. The rightmost element belongs to the current version. This status is expressed by the reserved keyword `+CURRENT-VERSION`. All other elements belong to a previous version and are marked with the reserved keyword `+PREVIOUS-VERSION`. APIs without interface versions are called unique.

APIs with interface versions are displayed intensified on the menu.

## Reserved Keywords

Reserved keywords refer to meta information on APIs, for example the Natural version in which an API has been added. Reserved keywords always start with a plus sign (`+`). See the table below for a description:

Reserved Keyword | Description
--- | ---
+CURRENT-VERSION | The current version of an API with interface versions (see Interface Versions).
+PREVIOUS-VERSION | A previous version of an API with interface versions (see Interface Versions).
+NEW-PROD-version | An API that has been added to a specific product in a specific version. For example, `+NEW-NAT-9.3.3` refers to an API that has been added to the product Natural in version `9.3.3`.
+MOD-PROD-version | An API that belongs to a specific product and has been modified in a specific version. For example, `+MOD-NAT-9.3.2` refers to an API that belongs to product Natural and has been modified in version `9.3.2`.

## Using a Natural API

If you want to use a Natural API contained in the system library SYSEXT, perform one of the following steps:

- Define the system library SYSEXT in the system file FNAT as a steplib library for the user library that contains the Natural objects that use this API. Thus, no API-specific actions are required when upgrading your Natural version.

- Copy the required API to the system library SYSTEM in the system file FNAT. Thus, you only need to check a single library for APIs when upgrading your Natural version.

- Copy the required API to the system library SYSTEM in the system file FUSER (not recommended).

- Copy the required API to the user library (or one of its steplibs) in the system file FUSER which contains the Natural objects that use this API (not recommended).

An API can only be used in the Natural version with which it is delivered. It is strongly recommended to store the APIs only in the FNAT system file. This will ensure that the right version is always executed.

To make use of an interface

1. In the calling program, use the `DEFINE DATA` statement to specify the parameters listed in the text object `USRnnnnT` of that API. In the example program `USRnnnnP`, the parameters are defined within the `DEFINE DATA LOCAL` statement. Alternatively, you can specify the parameters outside the calling program in a separate LDA (Local Data Area) or PDA (Parameter Data Area), with a `DEFINE DATA LOCAL USING` statement referencing that data area.

2. Enter the following statement:

       CALLNAT 'USRnnnnN' parameters

   For further information, see the CALLNAT statement in the Statements documentation.

Note
Non-standard usage is always documented in the respective text object `USRnnnnT`.

If you want to use a Natural copycode contained in the system library SYSEXT, perform the following step:

Copy the required copycode to the user library in the system file FUSER which contains the Natural objects that use this copycode.

To make use of a copycode

1. In the calling program, use the `INCLUDE` statement to specify the parameters listed in the text object `USRnnnnT` of that API or in the copycode itself. In the example program `USRnnnnP`, the parameters are defined within the `DEFINE DATA LOCAL` statement. Alternatively, you can specify the parameters outside the calling program in a separate LDA (Local Data Area) or PDA (Parameter Data Area), with a `DEFINE DATA LOCAL USING` statement referencing that data area.

2. Some copycodes require additional data definitions. These are described in the text object `USRnnnnT` of the API and in the copycode itself.

3. Enter the following statement:

       INCLUDE USRnnnnX 'parameter'...

   For further information, see the INCLUDE statement in the Statements documentation.

Note
Non-standard usage is always documented in the respective text object `USRnnnnT`.

## List of Natural APIs

The following list of Natural Application Programming Interfaces (APIs) available with the SYSEXT utility is for general information only. For the current status of APIs, execute the system command SYSEXT.

For detailed information on the use of APIs that apply to Natural Remote Procedure Call (RPC), refer to the section Application Programming Interfaces for Use with Natural RPC in the Natural Remote Procedure Call documentation.

Interface | Description | Product | Category | Keyword
--- | --- | --- | --- | ---
USR0010N | Get SYSPROF information | NAT | SYSTEM COMMANDS | DBID, ENVIRONMENT, FILE, FNAT, FNR, FUSER, SYSPROF
USR0011N | Get information on logical file | NAT | SYSTEM FILES | DBID, FNAT, FNR, FUSER, LFILE, SYSPROF
USR0020N | Read any error message from FNAT or FUSER | NAT | ERROR MESSAGES | *ERROR-NR, *LANGUAGE, ERROR, FNAT, FUSER, SYSERR
USR0040N | Get type of last error | NAT | ERROR HANDLING | *ERROR-NR, ERROR
USR0050N | Get SYSPROD information | NAT | SYSTEM COMMANDS | ENVIRONMENT, SYSPROD
USR0060N | Copy LFILE definition from FNAT to FUSER | NAT | SYSTEM FILES | FNAT, FNR, FUSER, LFILE
USR0080N | Get or set type and name of editor contents | NAT | EDITOR | EDITOR, NAME, OBJECT NAME, OBJECT TYPE, TYPE
USR0120N | Read Natural short error message | NAT | ERROR MESSAGES | *ERROR-NR, *LANGUAGE, ERROR, FNAT, SYSERR
USR0210N | Save, catalog or stow Natural object | NAT | NATURAL OBJECTS | CAT, EDITOR, ESIZE, OBJECT TYPE, SAVE, STOW, TYPE
USR0220N | Read Natural long error message | NAT | ERROR MESSAGES | *ERROR-NR, ERROR, FNAT, SYSERR
USR0221N | Read Natural long error message | NAT | ERROR MESSAGES | *ERROR-NR, *LANGUAGE, ERROR, FNAT, SYSERR
USR0320N | Read user short error message from FNAT or FUSER | NAT | ERROR MESSAGES | *ERROR-NR, *LANGUAGE, ERROR, FNAT, FUSER, SYSERR
USR0330N | Read Natural object directory | NAT | NATURAL OBJECTS | DIRECTORY
USR0360N | Modify user short error message on FNAT or FUSER | NAT | ERROR MESSAGES | *ERROR-NR, ERROR, FNAT, FUSER, SYSERR
USR0420N | Read user long error message from FUSER | NAT | ERROR MESSAGES | *ERROR-NR, ERROR, FUSER, SYSERR
USR0421N | Maintain user long error message on FUSER | NAT | ERROR MESSAGES | ERROR, FUSER, SYSERR
USR0500N | Define title of window | NAT | WINDOW HANDLING | TITLE, WINDOW
USR0600N | Get program level information | NAT | RUNTIME | *LEVEL
USR0610N | Get error information on last database call | NAT | ERROR HANDLING | *ERROR, DATABASE, ERROR
USR0620N | Convert string into ASCII or EBCDIC code | NAT | DATA HANDLING | ASCII, EBCDIC, LOWER CASE, TRANSLATE, UPPER CASE
USR0622N | Reset error counter in ON ERROR statement block | NAT | ERROR HANDLING | *ERROR-NR, ERROR, COUNTER
USR1002N | Save or restore Natural environment parameters | NAT | NATURAL ENVIRONMENT | ENVIRONMENT, PARAMETER
USR1005N | Get information on certain Natural session parameters | NAT | SESSION PARAMETERS | SESSION PARAMETER, PARAMETER, GLOBALS, NATPARM, AUTO, CC, CF, CPCVERR, CPU TIME LIMIT, DAY DIFFERENTIAL, DBUPD, DC, DD, DELETE, DELETE PROGRAMS, DFOUT, DFSTACK, DFTITLE, DO, DTFORM, DYNPARM, EJ, ERROR-TA, FCDP, FS, IA, ID, IM, LANGUAGE CODE, LE, LOWER-UPPER CASE, LS, LT, MADIO, MAXCL, MAXIMUM CPU TIME, MESSAGE LINE, ML, MT, NATURAL COMMANDS, NC, OPF, PF-KEY LINE, PM, PS, RECAT, REINP, RELEASE ISN, RI, SA, SF, SL, SM, STATUS LINE, STEPLIB, STRUCTURED MODE, TD, THSEPCH, TIME DIFFERENTIAL, TIMEZONE, TQMARK, TS, UDB, UPDATE COMMAND, WH, ZD, ZP
USR1009N | Convert store clock with sliding window into microseconds | NAT | DATE / TIME SUPPORT | *TIMESTMP, CONVERSION, DATE, MICROSECONDS, SLIDING WINDOW, STORE CLOCK, TIME
USR1011N | Check name for wildcard or asterisk notation | NAT | DATA HANDLING | ASTERISK, MASK, NAME, WILDCARD
USR1012N | Get dynamic error message parts from the last error | NAT | ERROR MESSAGES | *ERROR-NR, DYNAMIC, ERROR, SYSERR
USR1013N | Display current character set | NAT | CODE PAGE SUPPORT | EBCDIC, ASCII
USR1016N | Get error level for error in nested copycodes | NAT | RUNTIME | *ERROR-NR, *ERROR-TA, *LEVEL, COPYCODE, INCLUDE
USR1020N | Add user short error message to FUSER | NAT | ERROR MESSAGES | *ERROR-NR, ERROR, FUSER, SYSERR
USR1021N | Check name for wildcard or asterisk notation | NAT | DATA HANDLING | ASTERISK, MASK, NAME, WILDCARD
USR1022N | Get type of database | NAT | DATABASE | DATABASE, DBID, LFILE, TYPE
USR1023N | Convert time-related variables | NAT | DATE / TIME SUPPORT | *DATX, *TIMESTMP, *TIMX, CONVERSION, COPYCODE-INTERFACE, DATE, MICROSECONDS, STORE CLOCK, TIME
USR1025N | Maintain definition of multiple steplibs | NAT | STEPLIBS | *STEPLIB, LIBRARY, STEPLIB
USR1026N | Get information on RETURN data | NAT | RUNTIME | RETURN, SETUP
USR1027N | Search user short error message on FNAT or FUSER | NAT | ERROR MESSAGES | *LANGUAGE, ERROR, FNAT, FUSER, SYSERR
USR1028N | Convert bits and bytes | NAT | DATA HANDLING | BIT, BYTE
USR1029N | Get type of Natural object | NAT | NATURAL OBJECTS | OBJECT TYPE, TYPE
USR1030N | Convert language code | NAT | DATA HANDLING | *LANGUAGE
USR1031N | Check Natural object name | NAT | DATA HANDLING | NAME, OBJECT NAME
USR1032N | List cataloged Natural objects with type | NAT | NATURAL OBJECTS | NAME, OBJECT NAME, OBJECT TYPE, TYPE
USR1033N | Find DBID and FNR of a cataloged DDM | NAT | DDMS | DBID, DDM, FNR
USR1034N | Get NTTF file table with translated DBID and FNR | NAT | SYSTEM FILES | DBID, FNR, NTTF, TF, TRANSLATE
USR1035N | Maintain objects using the Software AG editor engine | NAT | EDITOR | BUFFER, EDITOR, SAG EDITOR, SOURCE
USR1036N | Maintain user profile of the Software AG editor | NAT | EDITOR | BUFFER, EDITOR, PROFILE, SAG EDITOR, SOURCE
USR1038N | Get platform-specific information | NAT | NATURAL ENVIRONMENT | ASCII, BYTE SWAPPING, CHECK, EBCDIC, ENVIRONMENT, GUI, PLATFORM
USR1039N | Modify the clipboard | NAT | DATA HANDLING | CLIPBOARD
USR1040N | Get or set profile parameter UDB | NAT | PROFILE PARAMETERS | DBID, DDM, GET, SET, UDB
USR1041N | Install error transaction program (*ERROR-TA) | NAT | ERROR HANDLING | *ERROR-NR, *ERROR-TA, ERROR
USR1042N | Get or set value of UPDATE command | NAT | DATABASE | DBUPD, GET, SET, UPDATE
USR1043N | Perform Adabas direct calls | NAT | DATABASE | ADABAS, DATABASE, DDM, FILE
USR1048N | Modify PF-key labels | NAT | NATURAL ENVIRONMENT | PF-KEY
USR1050N | Get or set work file name | NAT | WORK FILE / PRINTER | GET, SET, WORK FILE
USR1052N | Send a command to the operating system | NAT | RUNTIME | COMMAND, EXTERNAL
USR1053N | Get the value of an environment variable | NAT | NATURAL ENVIRONMENT | ENVIRONMENT, GET, VARIABLE
USR1054N | List libraries | NAT | NATURAL OBJECTS | FNAT, FUSER, LIBRARY, LIST, SYSTEM FILE
USR1055N | List objects in a library | NAT | NATURAL OBJECTS | FNAT, FSEC ENABLED, FUSER, LIST, MODULE, SOURCE, SYSTEM FILE
USR1056N | List DDMs on the FDIC file or in a library | NAT | DDMS | DDM, FDIC, FNAT, FSEC ENABLED, FUSER, LIST, MODULE, SOURCE, SYSTEM FILE
USR1057N | Read a Natural source code into an array | NAT | NATURAL OBJECTS | FNAT, FSEC ENABLED, FUSER, READ, SOURCE, SYSTEM FILE
USR1058N | Read a DDM source code into an array | NAT | DDMS | DDM, FDIC, FNAT, FSEC ENABLED, FUSER, READ, SOURCE, SYSTEM FILE
USR1059N | Initialize the Natural Reporter interface | NAT | REPORTER | INITIALIZE, REPORTER
USR1060N | Terminate the Natural Reporter interface | NAT | REPORTER | REPORTER, TERM, TERMINATE
USR1061N | Open an existing report layout | NAT | REPORTER | OPEN, REPORTER
USR1062N | Close a report | NAT | REPORTER | CLOSE, REPORTER
USR1063N | Select printer to print a report | NAT | REPORTER | PREVIEW, PRINT, PRINTER, REPORTER, SELECT
USR1064N | Print a report | NAT | REPORTER | PRINT, REPORTER
USR1065N | Preview a report | NAT | REPORTER | PREVIEW, REPORTER
USR1066N | Enable or disable the Natural message 'Executing ...' | NAT | ERROR HANDLING | EXECUTING, MESSAGE
USR1067N | Check Natural library name | NAT | DATA HANDLING | CHECK, LIBRARY, NAME
USR1068N | Maintain the number of DBMS calls, MAXCL and MADIO parameters | NAT | DATABASE | COUNTER, DATABASE, GET, MADIO, MAXCL, SET
USR1069N | Get or set a printer configuration | NAT | WORK FILE / PRINTER | GET, PRINTER, SET
USR1071N | Set credentials for RPC server | RPC | RPC - SECURITY | PASSWORD, RPC, SECURITY, TICKET, USER ID
USR1072N | Get command ID of a retain set | NAT | DATABASE | CID, COMMAND ID, RETAIN SET
USR2001N | Get information on last error | NAT | ERROR HANDLING | ERROR
USR2004N | Get information on logical file | NAT | SYSTEM FILES | DBID, FNAT, FNR, FUSER, LFILE, SYSPROF
USR2005N | Read internal file translation table | NAT | PROFILE PARAMETERS | NTTF
USR2006N | Get information from error message collector | NAT | ERROR MESSAGES | ERROR, *ERROR-NR
USR2007N | Get or set data for RPC default server | RPC | RPC | RPC, SERVER
USR2009N | Get dynamic error message parts from the last error | NAT | ERROR MESSAGES | *ERROR-NR, DYNAMIC, ERROR, SYSERR
USR2010N | Get error information on last database call | NAT | ERROR HANDLING | *ERROR, DATABASE, ERROR
USR2011N | Get or set work file name | NAT | WORK FILE / PRINTER | GET, SET, WORK FILE
USR2012N | Get system variable *NET-USER | NAT | NATURAL ENVIRONMENT | GET, *NET-USER
USR2013N | Get SYSPROF information | NAT | SYSTEM COMMANDS | DBID, ENVIRONMENT, FILE, FNAT, FNR, FUSER, SYSPROF
USR2014N | Maintain objects using the Software AG editor engine | NAT | EDITOR | BUFFER, EDITOR, SAG EDITOR, SOURCE
USR2018N | Read Natural object directory | NAT | NATURAL OBJECTS | DIRECTORY
USR2019N | Read or save Natural source code from/to the source area | NAT | EDITOR | EDITOR, FNAT, FSEC ENABLED, FUSER, READ, SAVE, SYSTEM FILE
USR2023N | Get type of database | NAT | DATABASE | DATABASE, DBID, LFILE, TYPE
USR2026N | Get TECH information | NAT | SYSTEM COMMANDS | ENVIRONMENT, ERROR, STEPLIB, TECH
USR2027N | Define wait interval for current session | NAT | RUNTIME | WAIT
USR2030N | Get dynamic error message parts from the last error | NAT | ERROR MESSAGES | *ERROR-NR, DYNAMIC, ERROR, SYSERR
USR2031N | Get SYSPROD information | NAT | SYSTEM COMMANDS | ENVIRONMENT, SYSPROD
USR2032N | Support commit for CLOSE CONVERSATION | RPC | RPC | CLIENT, CLOSE, CONVERSATION, RPC
USR2035N | Get or set parameters for SSL support | RPC | RPC | CLIENT, ENTIREX, RPC, SERVER, SSL
USR2036N | Convert binary variable (B8) into numeric variable (P20) | NAT | DATE / TIME SUPPORT | B8, BINARY, CONVERSION, COPYCODE-INTERFACE, NANOSECONDS, STORE CLOCK, TIME
USR2071N | Support EntireX Security on client side | RPC | RPC - SECURITY | CLIENT, ENTIREX, PASSWORD, PASSWORD PHRASE, RPC, SECURITY
USR2072N | Support EntireX Security on server side | RPC | RPC - SECURITY | ENTIREX, PASSWORD, PASSWORD PHRASE, RPC, SECURITY, SERVER
USR2073N | Ping or terminate a Natural RPC server | RPC | RPC | PING, RPC, SERVER, TERMINATE
USR2074N | Set new password for Natural Security user in RPC context | RPC | RPC - SECURITY | NEWPASSW, RPC, SERVER
USR2075N | Terminate EntireX Broker service | RPC | RPC | BROKER SERVICE, ENTIREX, RPC, SERVER, TERMINATE
USR2076N | Get or set RPC TIMEOUT value | RPC | RPC | GET, RPC, SET, TIMEOUT
USR3004N | Maintain internal Fast Locate Table | NAT | SERVER | BUFFER POOL, CLEAR, CLIENT, FAST, LOCATE, SERVER, TABLE
USR3013N | Get SYSPROF information | NAT | SYSTEM COMMANDS | DBID, ENVIRONMENT, FILE, FNAT, FNR, FUSER, SYSPROF
USR3025N | Maintain definition of multiple steplibs | NAT | STEPLIBS | *STEPLIB, LIBRARY, STEPLIB
USR3320N | Find user short error message (including steplibs search) | NAT | ERROR MESSAGES | *ERROR-NR, *LANGUAGE, ERROR, FNAT, FUSER, STEPLIB, SYSERR
USR4003N | Get Natural stack information | NAT | RUNTIME | STACK
USR4004N | Get dynamic Natural profile parameters at session start | NAT | PROFILE PARAMETERS | DYNAMIC, PARAMETER, PROFILE
USR4005N | Read all current PF-key settings | NAT | NATURAL ENVIRONMENT | KEY SETTING, PF-KEY
USR4007N | Get or set profile parameter SYNERR | NAT | PROFILE PARAMETERS | GET, SET, SYNERR
USR4008N | Set library for RPC execution | RPC | RPC | LOGON, RPC, SERVER
USR4009N | Set parameters for EntireX | RPC | RPC | CLIENT, RPC, SERVER
USR4010N | Get runtime settings of RPC server | RPC | RPC | RPC, RUNTIME, SERVER, SETTING
USR4011N | Create a hash value using SHA-1 | NAT | DATA HANDLING | HASH, METHOD, SECURITY, SHA-1
USR4012N | Set application error on RPC server | RPC | RPC | ENTIREX, RPC, SERVER
USR4025N | Maintain definition of multiple steplibs in Natural Security | NAT | STEPLIBS | *STEPLIB, LIBRARY, STEPLIB
USR4201N | Maintain data area sources | NAT | EDITOR | DATA AREA, GDA, FSEC ENABLED, LDA, PDA, SOURCE, SOURCE AREA
USR4206N | List objects in a library | NAT | NATURAL OBJECTS | FNAT, FSEC ENABLED, FUSER, LIST, MODULE, SOURCE, SYSTEM FILE
USR4208N | Read or write a Natural resource | NAT | RESOURCES | FSEC ENABLED, READ, RESOURCE, WRITE
USR4209N | Get short name of subroutine | NAT | NATURAL OBJECTS | LONG NAME, NAME, SUBROUTINE
USR4210N | Perform base64 conversion of alphanumeric and binary bytes | NAT | DATA HANDLING | ALPHA, BASE64, BINARY, CONVERSION, NETWORK, TCP/IP
USR4212N | Analyze data area | NAT | EDITOR | DATA AREA, FSEC ENABLED
USR4215N | Get list of resources in a Natural library | NAT | RESOURCES | FSEC ENABLED, LIST, RESOURCE
USR4217N | Send data to Optimize for Infrastructure | NAT | OPTIMIZE FOR INFRASTRUCTURE | DATA COLLECTOR, OPTIMIZE
USR4218N | Get information on Natural Development Server | NDV | SERVER | NDV, SERVER
USR4220N | Perform base64 conversion of alphanumeric and binary bytes | NAT | DATA HANDLING | ALPHA, BASE64, BINARY, CONVERSION, NETWORK, TCP/IP
USR4371N | Set credentials for RPC server (define user ID and ETID) | RPC | RPC - SECURITY | ETID, PASSWORD, RPC, SECURITY, TICKET, USER ID
USR5001N | Turn results window on/off | NAT | RESULT VIEW INTERFACE | RESULTS WINDOW
USR5002N | Maintain bitmaps and icons for a tab | NAT | RESULT VIEW INTERFACE | BITMAP, ICON, RESULTS WINDOW
USR5003N | Maintain context menus for a tab | NAT | RESULT VIEW INTERFACE | CONTEXT MENU, RESULTS WINDOW
USR5004N | Maintain general layout of a tab | NAT | RESULT VIEW INTERFACE | RESULTS WINDOW, TAB
USR5005N | Get or set active tab of results window | NAT | RESULT VIEW INTERFACE | RESULTS WINDOW, TAB
USR5006N | Define UpdateCommandHandler and CommandHandler for tab | NAT | RESULT VIEW INTERFACE | COMMAND HANDLER, TAB, RESULTS WINDOW
USR5007N | Maintain checked and enabled state for a context menu item | NAT | RESULT VIEW INTERFACE | CONTEXT MENU, RESULTS WINDOW
USR5008N | Maintain columns of a tab | NAT | RESULT VIEW INTERFACE | RESULTS WINDOW, TAB COLUMN
USR5009N | Get number of columns or rows of a tab | NAT | RESULT VIEW INTERFACE | RESULTS WINDOW, TAB COLUMN, TAB ROW
USR5010N | Maintain default column width and specific column width | NAT | RESULT VIEW INTERFACE | RESULTS WINDOW, TAB COLUMN, WIDTH
USR5011N | Maintain rows of a tab | NAT | RESULT VIEW INTERFACE | RESULTS WINDOW, TAB ROW
USR5012N | Get or set data of a tab | NAT | RESULT VIEW INTERFACE | DATA, RESULTS WINDOW
USR5013N | Maintain checked state of row(s) | NAT | RESULT VIEW INTERFACE | RESULTS WINDOW, TAB ROW
USR5014N | Maintain selected row(s) | NAT | RESULT VIEW INTERFACE | RESULTS WINDOW, TAB ROW
USR5015N | Get or set row of focus; scroll row into visible area | NAT | RESULT VIEW INTERFACE | FOCUS, RESULTS WINDOW, TAB ROW
USR5016N | Get or set data for UpdateCommandHandler and CommandHandler | NAT | RESULT VIEW INTERFACE | COMMAND HANDLER, DATA, RESULTS WINDOW
USR5017N | Copy selected row(s) to clipboard | NAT | RESULT VIEW INTERFACE | CLIPBOARD, RESULTS WINDOW
USR6001N | Call external XSLT processor | NAT | RUNTIME | XML, XSLT
USR6002N | Get the current values of internal counters | NAT | RUNTIME | COUNTER, GET, LT, MADIO, MAINPR, MAXCL, RUNTIME
USR6003N | Maintain type/name/library of program editor active window | NAT | EDITOR | EDITOR, NAME, OBJECT NAME, OBJECT TYPE, TYPE
USR6004N | Access the program editor active window | NAT | EDITOR | DELETE, EDITOR, GET, GOTO, INSERT, LINES, TEXT
USR6005N | Get information on program editor active window | NAT | EDITOR | ACTIVE, EDITOR, INFORMATION, WINDOW
USR6006N | Get path to system file | NAT | SYSTEM FILES | DBID, FNAT, FNR, FUSER, PATH, SYSTEM FILE
USR6007N | Get information on last error in Tamino database | NAT | ERROR HANDLING | ERROR, TAMINO
USR6008N | Get data of object in source area | NAT | EDITOR | LIBRARY, MODE, NAME, SOURCE AREA, TYPE
USR6009N | Maintain Natural buffer pool | NAT | BUFFER POOL | BUFFER POOL
USR6201N | Write source to Natural Development Server | NDV | SERVER | DDM, ERROR MESSAGE, NDV, SERVER, SOURCE
USR6202N | Get or set value of an environment variable | NAT | NATURAL ENVIRONMENT | ENVIRONMENT, GET, SET, VARIABLE
USR6203N | Maintain a resource in a Natural library | NAT | RESOURCES | CREATE, GET, PATH, RESOURCE
USR6204N | Set profile parameter PROGRAM | NAT | PROFILE PARAMETERS | BACKEND, PARAMETER, PROFILE, PROGRAM, SET
USR6303N | Get Natural stack information | NAT | RUNTIME | STACK
USR6304N | Get or set reliable state for RPC execution | RPC | RPC - RELIABLE RPC | CLIENT, RELIABLE, RPC, UOW
USR6305N | Commit or rollback reliable RPC messages | RPC | RPC - RELIABLE RPC | CLIENT, COMMIT, RELIABLE, ROLLBACK, RPC, UOW
USR6306N | Get status of UOWs of current EntireX Broker user | RPC | RPC - RELIABLE RPC | CLIENT, RELIABLE, RPC, UOW
USR6307N | Get or set Request Document timeout value (RQTOUT) | NAT | PROFILE PARAMETERS | GET, SET, REQUEST DOCUMENT, TIMEOUT
USR6308N | Retrieve system files defined in Natconf.cfg | NAT | NATURAL ENVIRONMENT | NATCONF, PATH, SYSTEM FILE
USR8208N | Terminate EntireX Broker service | RPC | RPC | BROKER SERVICE, ENTIREX, RPC, SERVER, SHUTDOWN-SERVICE, TERMINATE
USR8210N | Maintain Natural Profiler monitoring | NAT | PROFILER | PROFILER, TRACE
USR8213N | Shutdown server with sequence number on EntireX Broker | RPC | RPC | BROKER SERVER, ENTIREX, RPC, SEQUENCE NUMBER, SERVER, SHUTDOWN, SHUTDOWN-SERVER, TERMINATE
USR8215N | Get the Natural and NSC version | NAT | NATURAL ENVIRONMENT | NATVERS, NSC, SECURITY, VERSION
USR8216N | Maintain the RPC service directory | RPC | RPC | MAINTENANCE, NATCLTGS, RPC, SERVICE DIRECTORY
USR8217N | Search execution library for a Natural object | NAT | NATURAL ENVIRONMENT | EXECUTING, LIBRARY, STEPLIB
USR8219N | Perform Adabas direct calls using ACBX protocol | NAT | DATABASE | ACBX, ADABAS, DATABASE, DDM, FILE
USR8220N | Trigger termination of current RPC server | RPC | RPC | RPC, SERVER, TERMINATE
USR8221N | Generate codepage translation table | NAT | DATA HANDLING | ASCII, CODEPAGE, EBCDIC, TRANSLATE, TRANSLATION TABLE
USR8222N | Get Natural stack information | NAT | RUNTIME | STACK
USR8224N | Get Adabas file name | NAT | DATABASE | DATABASE, FILE, NAME
USR8225N | Maintain message ID and correlation ID of EntireX | RPC | RPC | CLIENT, CORRELATION ID, ENTIREX, MESSAGE ID, RPC, SERVER
USR8301N | Get Natural fix information | NAT | SYSTEM COMMANDS | ENVIRONMENT, FIX, SYSPROD
USR8302N | Define wait interval for current session | NAT | RUNTIME | WAIT
USR8401N | Read/Write dynamic error message parts | NAT | ERROR MESSAGES | *ERROR-NR, DYNAMIC, ERROR, SYSERR
USR9171N | Set user ID and password phrase for RPC server | RPC | RPC - SECURITY | PASSWORD, PASSWORD PHRASE, RPC, SECURITY, TICKET, USER ID
USR9175N | Ping, terminate or trace a Natural RPC server (pwd phrase) | RPC | RPC | PASSWORD PHRASE, PING, PWD PHRASE, RPC, SERVER, TERMINATE, TRACE, TRACEINFO
USR9176N | Terminate an EntireX Broker service (password phrase) | RPC | RPC | BROKER SERVICE, ENTIREX, PASSWORD PHRASE, RPC, SERVER, SHUTDOWN-SERVICE, TERMINATE
USR9177N | Shutdown server (seq. number) on EntireX Broker (pwd phrase) | RPC | RPC | BROKER SERVER, ENTIREX, PASSWORD PHRASE, RPC, SEQUENCE NUMBER, SERVER, SHUTDOWN, SHUTDOWN-SERVER, TERMINATE
USR9178N | Maintain local store clock value | NAT | DATE / TIME SUPPORT | *TIMESTMP, *TIMX, CONVERSION, COPYCODE-INTERFACE, DATE, LOCAL TIME, MICROSECONDS, SLIDING WINDOW, STORE CLOCK, TIME, TIME DIFFERENTIAL, TIMEZONE
USR9201N | Convert time-related variables | NAT | DATE / TIME SUPPORT | *DATX, *TIMESTMP, *TIMESTMPX, *TIMX, CONVERSION, COPYCODE-INTERFACE, DATE, DIFFERENCE, EXTENDED STORE CLOCK, MICROSECONDS, SLIDING WINDOW, SMART STORE CLOCK, STORE CLOCK, TIME
USR9205N | Create a hash value using SHA-256 or others | NAT | DATA HANDLING | HASH, METHOD, SECURITY, SHA-256

### On this page

- SYSEXT Prerequisites
- Introduction to SYSEXT
- Invoking and Terminating SYSEXT
- SYSEXT Tree View Items
- Performing SYSEXT Utility Functions
- Interface Versions
- Reserved Keywords
- Using a Natural API
- List of Natural APIs