Try OpenEdge Now
skip to main content
Web Services
The WSDL Analyzer : bprowsdldoc
 

bprowsdldoc

Runs the WSDL Analyzer, which provides HTML documentation on the interface that a Web Service Description Language (WSDL) describes. This HTML documentation describes how an ABL programmer can access the Web service and its operations in ABL.

Syntax

Operating system
Syntax
UNIX
Windows
bprowsdldoc
    [ -h ]
  |
    {
       [ -b | -nohostverify | -nosessionreuse
         | -WSDLUserid username  | -WSDLPassword password| -WSDLAuth [Authentication-type]
| -WSDLKeyFile [target-directory]| -WSDLKeyPwd [password]
         | -proxyhost host| -proxyport port
         | -proxyUserid username| -proxyPassword password
         | -show100style | -noint64|-servername

       ]...
       wsdl-url-or-filename[target-directory]
    }
-h
Displays a help message on the usage of this command.
-b
Forces documentation of binding names. A Web service can offer two options for a Web service client to connect (or bind) to it:
*Using services with ports (most common)
*Using binding names (the names of the WSDL <binding> elements) with SOAP endpoints that you must obtain separately (sometimes used to bind a SOAP viewer)
Normally, if a WSDL defines services, the Analyzer includes only the service and port names in the generated documentation. If the WSDL does not define any services, the Analyzer documents the binding names. This option tells the Analyzer to document the binding names even when services are defined in the WSDL. For more information on connecting to Web services, see Connecting to OpenEdge SOAP Web Services from ABL.
-nohostverify
Turns off host verification for a Secure Socket Layer (SSL) connection using HTTPS.
-nosessionreuse
Prevents any reuse of the SSL session ID for an HTTPS Web server connection when reconnecting the same Web server using HTTPS.
Note: OpenEdge SSL turns on SSL session reuse by default. So, after the initial connection to a given host (-H) and port (-S), each subsequent connection to the same host and port restarts the SSL session and ignores any different connection parameters that are specified for the subsequent connection, including -nosessionreuse. If you want to change SSL socket options (such as -nohostverify) for each subsequent connection to a given host and port, be sure to specify the -nosessionreuse parameter on the initial SSL socket connection to that same host and port.
-WSDLUserid username
Specifies a username for accessing the WSDL file.
-WSDLPassword password
Specifies a password for accessing the WSDL file.
-WSDLAuth password
Specifies if the access to a WSDL file requires SSL client authentication. Set this to ssl to enable SSL client authentication for WSDL access. If you set this to Basic, the connect method ignores client authentication for WSDL access.
-WSDLKeyFile password
Specifies the location of the client certificate. If you do not specify an absolute path of the client certificate file, the connection operation searches the $DLC/keys folder for the client-certificate-file-name.pem file. This option must be updated only if -WSDLAuth parameter is set to ssl.
-WSDLKeyPwd password
Specifies, in clear text or encoded format, the password of the client certificate. This option must be updated only if -WSDLAuth parameter is set to ssl.
-proxyhost host
Specifies the name or IP address of the host where an HTTP-based proxy server required to access the WSDL file is located.
-proxyport port
Specifies the port on which the HTTP-based proxy server is listening for requests to download WSDL files.
-proxyUserid username
Specifies a username for accessing an HTTP-based proxy server.
-proxyPassword password
Specifies a password for accessing an HTTP-based proxy server.
-show100style
Shows procedure and function signatures as documented in the 10.0x releases of OpenEdge. With the release of 10.1A, some procedure signatures are changed for ease of use. For more information, see Analyzing wrapped document literal.
-noint64
Prior to OpenEdge Version 10.1B, the ABL INT64 data type did not exist and the WDSL Analyzer mapped XML Schema types of xsd:long to the ABL DECIMAL data type. Use this option if you want to use the xsd:long to ABL DECIMAL mapping. Otherwise, xsd:long maps to INT64. The current version of OpenEdge continues to recognize existing mappings of xsd:long to DECIMAL as valid whether or not this option is specified.
wsdl-url-or-filename
Specifies a URL, Microsoft Uniform Naming Convention (UNC), or local pathname to the WSDL file. If the string does not specify a URL protocol ("file://", "http://", or "https://") or start with a UNC prefix ("\\"), it is assumed to be a a local file pathname.
target-directory
Specifies the target directory (to be created if necessary) where the Analyzer will write the generated documents. If not specified, the Analyzer assumes the current working directory. Choose a directory dedicated for the specified WSDL file, as some generated document filenames are the same for multiple WSDL files.
–servername
Specifies the server name in SSL connection initialization for client that it sends to the server as part of the TLS negotiation.
For more information on the documentation output from the WSDL Analyzer, see Using the WSDL Analyzer.