Overview of the IOMI Server Interface

The SAS Open Metadata Interface defines a set of methods that read and write metadata (the IOMI server interface), a set of methods for controlling the SAS Metadata Server (the IServer server interface), a set of methods for requesting authorization decisions from the authorization facility (the ISecurity server interface), and a set of methods for defining and administering access controls (the ISecurityAdmin server interface). This section describes the methods for reading and writing metadata.

We recommend that Java clients use the SAS Java Metadata Interface to read and write metadata instead of using the IOMI server interface directly. Information about IOMI methods is provided for users of PROC METADATA, which enables users to submit IOMI method calls that are formatted for the DoRequest method from the IN= argument. This section also provides background information for users of the SAS Java Metadata Interface and SAS metadata DATA step functions.

To access the IOMI methods, a client must connect to the SAS Metadata Server. A PROC METADATA user can specify SAS Metadata Server connection options in the procedure, in system options, or in a dialog box. For more information, see “Connection Options” in SAS Language Interfaces to Metadata.

Each IOMI method has a set of parameters that communicate the details of the metadata request to the SAS Metadata Server. For example, parameters identify the namespace to use as the context for the request, the repository in which to process the request, and the metadata type to reference. In addition, parameters specify flags and additional options to use when processing the request.

Methods that read and write metadata objects require you to pass a metadata property string that describes the object to the SAS Metadata Server. This metadata property string must be formatted in XML. For information about how to define a metadata property string, see Constructing a Metadata Property String.

Each IOMI method has two output parameters: a return code and a holder for information received from the SAS Metadata Server.

The return code is a Boolean operator that indicates whether the method communicated with the SAS Metadata Server. A 0 indicates that communication was established. A 1 indicates that communication was not established. The return code does not indicate the success or failure of the method call itself. It is the responsibility of SAS Open Metadata Interface clients to provide error codes.

All other output received from the SAS Metadata Server is in the form of formatted XML strings. The output typically mirrors the input, with the exception that requested values are filled in.