Basic SYSRPC Functions

#### Search Results

Search

# Basic SYSRPC Functions

This section provides instructions for starting and terminating the SYSRPC utility and describes the main features and functions provided by the utility.

- Invoking SYSRPC

- Terminating SYSRPC

- Service Directory Tree

- Menu Bar

- Toolbar

- Context Menu

## Invoking SYSRPC

To invoke the SYSRPC utility

1. From the library workspace in the Natural Studio tree view, select a library.

2. From the Tools menu, choose Configuration Tools and Remote Procedure Call.

   Or:
   In the Command line, enter the following command:

       SYSRPC

   The SYSRPC - Remote Procedure Call window appears and displays the service directory tree view for the library specified. This is indicated in the name of the directory root node: Service Directory [library-name].

   When you invoke SYSRPC for the first time for a library, as shown in the example below, the tree view contains example (dummy) data. The name of the service directory root node is Example Service Directory which will change to Service Directory [library-name] when you use the Save or Save As function (see Menu Bar below), regardless of any tree view modifications. For a list of possible root names, see Root Node Names in the section Service Directory Maintenance.

The menus and toolbar buttons in the SYSRPC - Remote Procedure Call window provide all functions required to maintain a service directory, generate interface objects and execute server commands.

## Terminating SYSRPC

To terminate the SYSRPC utility

- In the SYSRPC - Remote Procedure Call window, from the Object menu, choose Exit.

  Or:
  Choose ALT+F4.

  Or:
  Choose the standard Windows close function.

If a window appears with a message saying that subprogram NATCLTGS is missing (needed at runtime), choose Yes to confirm the generation of NATCLTGS, or choose No to cancel the operation.

## Service Directory Tree

The tree view in the SYSRPC - Remote Procedure Call window displays all items (tree nodes) required for service directory maintenance. For explanations of the tree nodes, see Tree Nodes in Service Directory Maintenance. For explanations of the tree node hierarchy, see Service Directory Concept in Service Directory Maintenance.

Do not confuse a tree node of the service directory with the node to which an RPC connection is established (see Natural RPC Terminology in the Natural RPC (Remote Procedure Call) documentation).

You can manipulate the tree nodes by using the functions provided with the menu bar, the toolbar and the context menu described below.

You can expand or collapse tree nodes by choosing the toggle (expand) or the toggle (collapse) in front of a tree node. Alternatively, you can choose the ARROW keys. Double-click on an expandable tree node to display all subordinate items.

To expand all nodes of a tree

- In the SYSRPC - Remote Procedure Call window, select the root node and choose Expand Tree from the context menu.

  Or:
  Choose CTRL+F12.

## Menu Bar

The menus, menu items and equivalent shortcut keys (if available) provided to execute SYSRPC functions are described in the following section.

Menu | Menu Item and Shortcut | Explanation
--- | --- | ---
Object | Open | Opens a service directory: From the Type drop-down list box, select the type of service directory (default is SERVDIRX or NATCLTGS) and, if required, in the Library text box, replace the name of the library (default is the current library). The non-modifiable text box underneath Library displays the database ID (DBID), the file number (FNR) and the type of Natural file (`FNAT` = system, `FUSER` = user) for the library specified.
Save CTRL+S | Saves the service directory in the current library.
Save As | Saves the service directory in another library.
Properties | Invokes the Properties of Service Directory dialog box. It provides information on the generation of the service directory:
Object | The name of the service directory.
Generated by | The name of the Natural utility.
Environment | If the directory was generated in a local environment, the value `local` is displayed. Otherwise, the name of a remote server is displayed.
Library | The name of the library in which the service directory was generated.
User | The ID of the user who generated the service directory.
Time stamp | The date and the time at which the service directory was last modified.
Tree view nodes | The number of tree nodes including the service directory root node.
Expiration time | The remote directory data is loaded at runtime. The expiration time in seconds determines the period of validity of this data. If directory data is requested after the expiration time set, it will automatically be reloaded. If the expiration time is set to `0`, the remote directory data will not be reloaded.
Exit CTRL+F4 | Terminates SYSRPC.
Edit | New Item | Creates a new tree node item. Depending on the tree node selected, you have the following choices:
Node | Corresponding toolbar button:
RPC Server | Corresponding toolbar button:
Library | Corresponding toolbar button:
Service (Subprogram) | Corresponding toolbar button:
See also the section Natural RPC Terminology in the Natural RPC (Remote Procedure Call) for explanations of relevant expressions.
Rename CTRL+F2 | Modifies the name of a tree node.
Delete | Removes a tree node.
Cut CTRL+X Copy CTRL+C Paste CTRL+V | Cuts, copies or pastes a tree node.
Find CTRL+F | Invokes the Find Item window to search for a name:
Find | Enter an alphanumeric search string of up to 32 characters.
Case sensitive | Select this check box to distinguish between uppercase and lowercase characters.
Whole words only | Select this check box to search for complete character strings only.
Choose OK to start searching and move to the first hit, which is highlighted. Corresponding toolbar button:
Find Next F3 | Searches for additional instances of the search string specified in the Find Item window and moves to the next hit if one exists. Corresponding toolbar button:
Replace CTRL+H | Invokes the Replace Item window to replace a name:
Find | Enter an alphanumeric search string of up to 32 characters.
Case sensitive | Select this check box to distinguish between uppercase and lowercase characters.
Whole words only | Select this check box to search for complete character strings only.
Replace all | Select this check box to replace all search strings found.
Choose OK to start searching and replacing the specified character strings. Corresponding toolbar button:
Replace Next CTRL+F3 | Searches for additional instances of the search string specified in the Replace Item window and moves to the next hit if one exists. Corresponding toolbar button:
Tools | Ping CTRL+F9 | Sends an internal message to verify server connections described in the section Server Command Execution. Corresponding toolbar button: See also Pinging an RPC Server.
Terminate Server | Sends an internal message to terminate server connections as described in the section Server Command Execution. See also Terminating an RPC Server.
Terminate Server with Sequence Number CTRL+F10 | Sends a shutdown request with sequence number to the EntireX Broker as described in the section Server Command Execution. See also Terminating an RPC Server.
Terminate EntireX Broker Service | Requests termination of an EntireX Broker service as described in the section Server Command Execution. Corresponding toolbar button:
Single Interface Object Generation CTRL+F8 | Generates single interface objects as described in Generating Single Interface Objects with Parameter Specification in the section Generating Interface Objects.
Interface Object Mass Calculation CTRL+F5 | Performs calculations for size requirements of RPC calls as described in the section Calculating Size Requirements.
Interface Object Mass Generation CTRL+F6 | Generates single or multiple interface objects online or batch as described in Using the Interface Object Mass Generation Function in the section Generating Interface Objects.
Interface Object Generation from IDL CTRL+F7 | Generates interface objects or parameter data areas (PDAs) from IDL files as described in Generating Interface Objects or PDAs from IDL Files in the section Generating Interface Objects.
Help |  | Displays SYSRPC help text: SYSRPC Utility - Overview Server Command Execution (Ping, Terminate) Expiration Time Logon Option Transport Protocol Service Directory Tree Generating Single Interface Objects with Parameter Specification Generating Multiple Interface Objects Generating Interface Object or PDAs from IDL Files Calculating Size Requirements

## Toolbar

The toolbar buttons that provide quick access to frequently used SYSRPC functions are described in the following section.

Toolbar Button | Function
--- | ---
| Adds a new tree node item. See also the corresponding menu: Edit > New Item > Node.
| Adds a new RPC server item. See also the corresponding menu: Edit > New Item > RPC Server.
| Adds a new library item. See also the corresponding menu: Edit > New Item > Library.
| Adds a new service (subprogram) item. See also the corresponding menu: Edit > New Item > Service (Subprogram).
| Finds a character string. See also the corresponding menu: Edit > Find.
| Finds the next character string. See also the corresponding menu Edit > Find Next.
| Pings RPC servers. See also the corresponding menu: Edit > Ping.
| Terminates an EntireX Broker service. See also the corresponding menu: Edit > Terminate EntireX Broker Service.

## Context Menu

The context menu provides alternative ways of executing the commands and functions provided by the menus and the toolbar in the SYSRPC - Remote Procedure Call window.

In addition, the context menu provides the following options:

- Expand Tree described in Service Directory Tree,

- Logon Option described in Service Directory Maintenance,

- Transport Protocol described in Service Directory Maintenance, and

- List Natural RPC servers described in Viewing a Server List and Viewing Additional Server Information in the section Listing Servers Registered on EntireX Broker.

### On this page

- Invoking SYSRPC
- Terminating SYSRPC
- Service Directory Tree
- Menu Bar
- Toolbar
- Context Menu