File Utility Program (FUP) Management Programming Manual

File Utility Program (FUP) Management Programming Manual—523322-001

4-1

ORSERV Programmatic Interface

This section describes how a management application program uses the Subsystem

Programmatic Interface (SPI) to communicate with an ORSERV process. You can use

SPI to execute these ORSERV commands from an application written in C, COBOL85,

TACL or TAL:

Communicating With ORSERV

To communicate with an ORSERV process, you must follow a few basic procedures.

These procedures are listed in Figure 4-1

on page 4-2 and described here using the

same numbering:

1. Start an ORSERV process.

You must start ORSERV on the same system as the target file. If you start

ORSERV on one system to reload a file on another system, you receive error 10

(ZORS-ERR-WRONG-SERVER).

You can use a process-creation procedure (such as PROCESS_LAUNCH_) to

start an ORSERV process. You can find ORSERV in the

$SYSTEM.SYSnn.ORSERV program file.

Before you start the ORSERV process, use the CREATEPROCESSNAME

procedure to obtain a system-assigned process name.

GETVERSION Returns the ORSERV server version and the server ID

ONLINERELOAD Performs an online reload of a key-sequenced file or SQL object

STATUS Returns the status of an online reload operation (either executing or

suspended)

SUSPEND Suspends an executing online reload operation.

Topic Page

Communicating With ORSERV

4-1

Elements of SPI Messages for ORSERV 4-9

Naming Rules for Applications 4-9

SPI Programming Considerations for ORSERV 4-12

Common Definitions 4-19

Note. Before you read this section, you should be familiar with the information in the SPI

Programming Manual.

Note. For more system procedure information, see the Guardian Procedure Calls

Reference Manual.