Previous Page | Next Page

METADATA Procedure

PROC METADATA Statement


PROC METADATA <server-connection-arguments>
IN = "XML-formatted-method-call" | fileref
<OUT = fileref>
<HEADER = NONE | SIMPLE | FULL>
<VERBOSE>;

Task Argument
Connect to the metadata server Server Connection Arguments
Specify an XML-formatted method call, or an XML file that contains the method call IN=
Save the XML output in a file OUT=
Add a character-set encoding tag to the XML output HEADER=
Write the input XML string to the log VERBOSE


Server Connection Arguments

The server connection arguments establish communication with the metadata server. If you omit these arguments, then the values of the system options are used, or the values can be obtained interactively. For more information, see Connection Options.

PASSWORD="password"

is the password for the authenticated user ID on the metadata server. If you do not specify PASSWORD=, the value of the METAPASS= system option is used; for more information, see METAPASS= System Option. The maximum length is 512 characters.

Alias: METAPASS=
PW=
PORT=number

is the TCP port that the metadata server listens to for requests. This port number was used to start the metadata server. If you do not specify PORT=, the value of the METAPORT= system option is used; for more information, see METAPORT= System Option. The default for the METAPORT= system option is 8561. The range is 1-65535.

Alias: METAPORT=
Requirement: Do not enclose the value in quotation marks.
PROTOCOL=BRIDGE

specifies the network protocol for connecting to the metadata server. If you do not specify PROTOCOL=, the value of the METAPROTOCOL= system option is used; for more information, see METAPROTOCOL= System Option. In this release, the only supported value is BRIDGE, which specifies the SAS Bridge protocol.

Alias: METAPROTOCOL=
Requirement: Do not enclose the value in quotation marks.
REPOSITORY= "name"

is the name of the SAS Metadata Repository to use when resolving the $METAREPOSITORY substitution variable. PROC METADATA enables you to specify the substitution variable $METAREPOSITORY in your input XML. The substitution variable is resolved to the repository that you specify in REPOSITORY=. This value is the repository's Name= attribute. If you do not specify REPOSITORY=, the value of the METAREPOSITORY= system option is used; for more information, see METAREPOSITORY= System Option. The default for the METAREPOSITORY= system option is Foundation. The maximum length is 32,000 characters.

Alias: METAREPOSITORY=
REPOS=
SERVER="host-name"

is the host name or network IP address of the computer that hosts the metadata server. The value localhost can be used if the SAS session is connecting to the metadata server on the same computer. If you do not specify SERVER=, the value of the METASERVER= system option is used; for more information, see METASERVER= System Option. The maximum length is 256 characters.

Alias: HOST=
IPADDR=
METASERVER=
USER="authenticated-user-ID"

is an authenticated user ID on the metadata server. The metadata server supports several authentication providers. For more information about authentication, see the SAS Intelligence Platform: Security Administration Guide. If you do not specify USER=, the value of the METAUSER= system option is used; for more information, see METAUSER= System Option. The maximum length is 256 characters.

Alias: ID=
METAUSER=
USERID=

Input Argument

IN= " XML-formatted-method-call " | fileref

specifies an XML-formatted method call, or specifies an XML file that contains the method call.

You form the method call as if you were submitting it with the inMetadata parameter of the DoRequest method. The methods are part of the SAS Open Metadata Interface. For more information, see Concepts: METADATA Procedure. See also Filerefs with the IN= and OUT= Arguments and Fileref to a Temporary File with the IN= Argument.

Note:   Under z/OS, fixed-length records in the XML method call are not supported by PROC METADATA. Specify RECFM=V when you create the XML method call.  [cautionend]


Output Arguments

OUT=fileref

specifies an XML file in which to store the output that is returned by the metadata server. The value must be a fileref, not a pathname. Therefore, you must first submit a FILENAME statement to assign a fileref to a pathname. In most cases, the output XML string is identical to the input XML string, with the addition of the requested values within the XML elements. If the OUT= argument is omitted, PROC METADATA output is written to the SAS log. For more information, see Results: METADATA Procedure. See also Filerefs with the IN= and OUT= Arguments.

Note:   PROC METADATA can generate large XML output. You might need to specify a large LRECL value or RECFM=N (streaming output) to avoid truncation of long output lines.  [cautionend]

Note:   Under z/OS, fixed-length records in the XML method call are not supported by PROC METADATA. Specify RECFM=V (or RECFM=N as suggested above) when you create the XML method call.  [cautionend]

HEADER= NONE | SIMPLE | FULL

specifies whether to include an XML header in the output XML file. The declaration specifies the character-set encoding for Web browsers and XML parsers to use when processing national language characters in the output XML file. For more information, see HEADER= Argument.

NONE

omits an encoding declaration. Web browsers and parsers might not handle national language characters appropriately.

SIMPLE

inserts an XML header that specifies the XML version number: <?xml version="1.0"?>.

FULL

inserts an XML declaration that represents the encoding that was used when creating the output XML file. In most cases, the encoding is recognized by Web browsers and XML parsers. However, if you encounter errors, you might want to know where SAS finds the encoding, and how SAS uses the encoding.

  1. The source for the encoding varies, depending on the operating environment. In general, the encoding value is taken from the ENCODING= option specified in the FILENAME argument, or from the ENCODING= system option.

  2. SAS attempts to use that encoding for the output XML file (and in the XML header). The encoding can vary. A single encoding can have multiple names or aliases that can appear in the XML header. These names might not be valid or recognized in all XML parsers. When generating the encoding attribute in the XML header, SAS attempts to use an alias that will be recognized by Internet Explorer. If the alias is not found, SAS attempts to use a name that will be recognized by Java XML parsers. If the name is not found, SAS uses an alias by which SAS will recognize the encoding.

For information about encoding and transcoding, see SAS National Language Support (NLS): Reference Guide.

VERBOSE

specifies to print the input XML string after it has been preprocessed. For more information, see VERBOSE Argument.

Previous Page | Next Page | Top of Page