SOAP Procedure

PROC SOAP Statement

Invokes a Web service through Java Native Interface (JNI).

Syntax

PROC SOAP options <properties>;

Summary of Optional Arguments

sets the timeout limit for Web service calls.
specifies an output log file.
specifies the location of the SAS environments file.
specifies that you use the environment that is defined in the SAS environments file.
specifies the setting for the mustUnderstand attribute.
specifies a fileref for response output.
specifies an HTTP proxy server domain.
specifies an HTTP proxy server host name.
specifies an HTTP proxy server password.
specifies an HTTP proxy server port.
specifies an HTTP proxy server user name.
specifies a SOAPAction element.
specifies the URL of the System Registry Service.
specifies user name and password retrieval from metadata.
specifies the domain or realm for a user name and password.
specifies a password for Web service authentication.
specifies a user name for Web service authentication.
specifies that the active connection to the SAS Metadata Server will be used to retrieve credentials.
specifies a WS-Security password.
specifies a WS-Security user name.

Required Arguments

IN=fileref 'your-input-file'
specifies the fileref that is used to input XML data that contains a PROC SOAP request.
The fileref might have SOAPEnvelope and SOAPHeader elements as part of its content, but they are not required unless you have specific header information to provide.
SERVICE
specifies the SAS registered Web service that you want to call.
Note:If you use the SERVICE option, then do not use the URL option.
URL
specifies the URL of the Web service endpoint.
Note:If you use the URL option, then do not use the SERVICE option.

Optional Arguments

CONFIGFILE
enables you to set the timeout limit for Web service calls. The default timeout is 60 seconds.
DEBUG
enables you to specify an output log file. The debug option turns on wire logging for httpclient and writes the output to the specified file. The value of this option is the path or filename to the desired output.
ENVFILE
specifies the location of the SAS environments file.
ENVIRONMENT
specifies to use the environment that is defined in the SAS environments file.
MUSTUNDERSTAND
specifies the setting for the mustUnderstand attribute in the PROC SOAP header.
OUT=fileref 'your-output-file'
specifies the fileref where the PROC SOAP XML response output is written.
PROXYDOMAIN
specifies an HTTP proxy server domain.
Note:This option is required only if your proxy server requires domain- or realm-qualified credentials.
PROXYHOST
specifies an HTTP proxy server host name.
PROXYPASSWORD
specifies an HTTP proxy server password. Encodings that are produced by PROC PWENCODE are supported.
Note:This option is required only if your proxy server requires credentials.
PROXYPORT
specifies an HTTP proxy server port.
PROXYUSERNAME
specifies an HTTP proxy server user name.
Note:This option is required only if your proxy server requires credentials.
SOAPACTION
specifies a SOAPAction element to invoke on the Web service.
SRSURL
specifies the URL of the System Registry Service.
WEBAUTHDOMAIN
specifies that a user name and password be retrieved from metadata for the specified authentication domain.
WEBDOMAIN
specifies the domain or realm for the user name and password for NTLM authentication.
WEBPASSWORD
specifies a password for either basic or NTLM Web service authentication. Encodings that are produced by PROC PWENCODE are supported.
WEBUSERNAME
specifies a user name for either basic or NTLM Web service authentication.
WSSAUTHDOMAIN
specifies that the active connection to the SAS Metadata Server will be used to retrieve credentials in the specified authentication domain.
If credentials are found, they will be used as the credentials for a WS-Security UsernameToken.
WSSUSERNAME
specifies a WS-Security user name. If a value is set, then WS-Security is used and a UsernameToken is sent with the Web service request for user authentication, security, and encryption.
WSSPASSWORD
specifies a WS-Security password that is the password for WSSUSERNAME. Encodings that are produced by PROC PWENCODE are supported.

Properties

ENVELOPE
specifies that a SOAP envelope is to be included in the response.