|
|
The BEA SALT Command Reference describes, system processes and commands delivered with the BEA SALT software.
GWWS – Web service gateway server.
GWWS SRVGRP="identifier" SRVID=number [other_parms]
CLOPT="-A -- – i InstanceID"
The GWWS server is the Web service gateway for Tuxedo applications, the core component of BEA SALT. The GWWS gateway server provides communication with Web service programs via SOAP 1.1/1.2 protocols. The GWWS server has bi-directional (inbound/outbound) capability. It can accept SOAP requests from Web service applications and passes Tuxedo native calls to Tuxedo services (inbound). It also accepts Tuxedo ATMI requests and passes SOAP calls to Web service applications (outbound). GWWS servers are used as Tuxedo system processes and are described in the *SERVERS section of the
UBBCONFIG file.
The CLOPT option is a string of command-line options passed to the GWWS server when it is booted. The GWWS server accepts the following CLOPT options:
GWWS instance unique ID. It is used to distinguish multiple GWWS instances provided in the same Tuxedo domain. This value must be unique among multiple GWWS items within the UBBCONFIG file.
| Note: | The InstanceID value must be pre-defined in the <WSGateway> section of the BEA SALT Deployment File. |
The environment variable SALTCONFIG must be set before GWWS server is booted.
The following SALT 1.1 GWWS parameter is deprecated in the current release.
| Note: | In the SALT 2.0 release, the GWWS server loads the SALT configuration from the binary SALTCONFIG file instead of the XML-based configuration file. The configuration file is no longer a GWWS server input parameter. The SALTCONFIG file must be generated using wsloadcf before booting GWWS servers. |
For inbound call, if an error occurs during SOAP message processing, the error is logged. The error is also translated into appropriate SOAP fault and/or HTTP error status code and returned to the Web Service client.
For outbound call, if an error occurs during processing, the error is logged. The error is also translated into appropriate Tuxedo system error code (tperrno) and returned to the Tuxedo client.
GWWS SRVGRP=GROUP1 SRVID=10
CLOPT="-A -- – i GW1"
GWWS SRVGRP=GROUP1 SRVID=11
CLOPT="-A -- – i GW2"
GWWS SRVGRP=GROUP2 SRVID=20
CLOPT="-A -- – i GW3"
SALT Deployment File Reference
SALT Web Service Definition File Reference
tmwsdlgen – WSDL document generator.
tmwsdlgen – c wsdf_file [-y] [-o wsdl_file] [-m {pack|raw|mtom}] [-t {wls|axis}]
tmwsdlgen generates a WSDL document file from a Tuxedo native Web Service Definition File (WSDF). The generated WSDL document is WSDL 1.1 specification compliant, and represents both the service contracts and policies. tmwsdlgen collects Tuxedo service contract information throughout the Tuxedo Service Metadata Repository management (TMMETADATA)process. tmwsdlgen works as a Tuxedo native client and requires the following:
| WARNING: | The given WSDF must be a Tuxedo native WSDF. Do not use a wsdlcvt converted non-native WSDF file as input. |
tmwsdlgen accepts the following parameters:
tmwsdlgen accepts the following optional parameters:
tuxedo.wsdl, is created in the current directory. If the specified WSDL document file already exists, then a prompt displays to confirm to overwriting the existing file.
raw mode is specified, CARRAY is represented to the MIME attachment. If pack mode is specified, xsd:base64Binary is used to represent CARRAY. The default value is pack mode.
| Note: | raw mode cannot be used for .Net clients. The .Net Framework does not support MIME attachments. |
-m option is specified in raw mode. It accepts two options, wls or axis:
The following SALT 1.1 tmwsdlgen parameters are deprecated in the current release.
| Note: | In the current SALT release, the SALT 1.1 configuration file is specified as the tmwsdlgen input using the following optional parameters: |
| Note: | In the current SALT release, the SOAP version and message style attribute are specified in the BEA SALT WSDF. |
If a syntax error is detected in the given WSDF, an “ERROR” or “FATAL” message indicating that problem is printed to the standard error, and no WSDL file is generated and tmwsdlgen exits with exit code 1.
A “WARN” message is printed to the console if (1) WSDF content may result in a potential runtime risk or (2) default values are used because they are not specified in the WSDF. “WARN” messages do not interrupt tmwsdlgen execution.
Upon successful completion, tmwsdlgen exits with exit code 0.
The following command generates a WSDL document file, Salt.wsdl, from the specified SALT WSDF, tux.wsdf.
tmwsdlgen – c tux.wsdf – o Salt.wsdl
The following command generates a default WSDL document file with SOAP w/ Attachment capability from the specified SALT WSDF, app_wsdf.xml.
tmwsdlgen – c app_wsdf.xml – m raw
SALT Web Service Definition File Reference
wsadmin – BEA SALT administration command interpreter.
wsadmin [-v]
wsadmin uses specific commands to monitor and administrate active GWWS processes in the specified Tuxedo domain. The TUXCONFIG environment variable is used to determine the location where the Tuxedo configuration file is loaded. wsadmin is used in the same manner as tmadmin(1) or dmadmin(1).
wsadmin accepts below optional parameter:
Commands may be entered using either their full name or their abbreviation (as given in parentheses), followed by any appropriate arguments. Arguments appearing in brackets, [ ], are optional; arguments in braces, {}, indicate a selection from mutually exclusive options.
| Note: | Command line options that are not in brackets do not need to appear in the command line if the corresponding default has been set via the default command. |
wsadmin supports the following commands:
configstats(cstat) -i gwws_instance_id
Displays the current configuration status for the specified GWWS process. The -i parameter must be specified.
default(d) [-i gwws_instance_id]
Sets the corresponding argument to the default GWWS Instance ID. The defaults can be changed by specifying * as an argument. If the default command is entered without arguments, the current defaults are printed.
Echoes input command lines when set to on. If no option is given, the current setting is toggled, and the new setting is printed. The initial setting is off.
Prints help messages. If command is specified, the abbreviation, arguments, and description for that command are printed.
Omitting all arguments causes the syntax of all commands to be displayed.
gwstats(gws) -i gwws_instance_id [-s serviceName]
Displays global level runtime statistics information for the specified GWWS processes including fail, success, pending number for both inbound and outbound call, average processing time, active thread number, etc. If -s serviceName specified, the server-level information is displayed.
Paginates output. If no option is given, the current setting is toggled, and the new setting is printed. The initial setting is on, unless either standard input or standard output is a non-tty device. Pagination may be turned on only when both standard input and standard output are tty devices.
The default paging command is indigenous to the native operating system environment. In a UNIX operating system environment, for example, the default paging command is pg. The shell environment variable PAGER may be used to override the default command used for paging output
Produces output in verbose mode. If no option is given, the current setting is toggled, and the new setting is printed. The initial setting is off.
Escapes to the shell and executes shell command.
Repeats previous shell command.
Specifies comments. Lines beginning with # are ignored.
1.The following command inspects runtime statistics for both inbound and outbound service on GW2:
wsadmin
> gws -i GW2GWWS Instance : GW2
Inboud Statistics :
---------------------------------
Request Response Succ : 3359
Request Response Fail : 0
Oneway Succ : 0
Oneway Fail : 0
Total Succ : 3359
Total Fail : 0
Avg. Processing Time : 192.746 (ms)
---------------------------------
Outboud Statistics :
---------------------------------
Request Response Succ : 4129
Request Response Fail : 0
Oneway Succ : 0
Oneway Fail : 0
Total Succ : 4129
Total Fail : 0
Avg. Processing Time : 546.497 (ms)
-----------------------------------
Total request Pending : 36
Outbound request Pending : 0
Active Thread Number : 141
2.The following command inspects runtime statistics for the ToUpperWS service on GW1 and gets output in verbose mode.
wsadmin
> > verbose
Verbose now on.
> gws -i GW1 -s ToUpperWS
GWWS Instance : GW1
Service : ToUpperWS
Outboud Statistics :
----------------------------------
Oneway Succ : 0
Oneway Fail : 0
---------------------------------
Avg. Processing Time : 0.000 (ms)
wsdlcvt – WSDL document converter.
wsdlcvt -i WSDL_URL -o output_basename [-m] [-v] [-y] [-w]
wsdlcvt is used to convert an existing WSDL 1.1 document to a Metadata Input File, FML32 mapping File and BEA SALT Web Service Definition File (WSDF). It is a wrapper script for wsdl2mif.xsl, wsdl2fml32*.xsl and wsdl2wsdf.xsl for Xalan. Apache Xalan 2.7 libraries are bundled with BEA SALT product.
JRE 1.5 or higher is required to run wsdlcvt.
wsdlcvt accepts the following parameters:
wsdlcvt accepts the following optional parameters:
wsdlcvt works in verbose mode. In particular, it shows context information in the message and output context as FML32 field comments.
wsdlcvt can handle it correctly.
The TUXDIR and LANG environment variables must be set correctly.
The PATH environment variable must be set appropriately to execute “java”.
Error, warning or information messages are output to standard output.
The following command converts the local WSDL file, sample.wsdl.
wsdlcvt -i sample.wsdl -o sample
The following command converts a WSDL document from a HTTP URL link. The “xsd:string” data type is mapped to the Tuxedo FLD_MBSTRING field type.
wsdlcvt -i http://api.google.com/GoogleSearch.wsdl -o GSearch -m
Creating The Tuxedo Service Metadata Repository
SALT Web Service Definition File Reference
wsloadcf – Reads a SALT Deployment file and other referenced artifacts, and loads a binary SALTCONFIG file.
Usage 1: wsloadcf [-n][-y][-D loglevel] saltdeploy_file
Usage 2: wsloadcf [-n][-y][-D loglevel] -1 [-s rpc|doc][-v 1.1|1.2] salt_1.1_config
wsloadcf reads a SALT deployment file and other referenced files (WSDF files, WS-Policy files), checks the syntax, and optionally loads a binary SALTCONFIG file. The SALTCONFIG environment variable points to the SALTCONFIG file where the information should be stored. The generated SALTCONFIG file is necessary to boot GWWS servers.
wsloadcf accepts the following optional parameters:
tmloadcf checks whether: (a) the file referenced by SALTCONFIG exists; (b) it is a valid BEA Tuxedo system file system; and (c) it contains SALTCONFIG tables. If these conditions are not true, wsloadcf prompts you to indicate whether you want the command to create and initialize SALTCONFIG.
Initialize SALTCONFIG file: path [y, q]?
Prompting is suppressed if the -y option is specified on the command line.
For SALT 1.1 backward compatibility, wsloadcf can also read a SALT 1.1 configuration file. Besides generating the SALTCONFIG binary file, wsloadcf also generates one SALT Web Service Definition File (WSDF) and one SALT Deployment file according to the given SALT 1.1 configuration file.
wsloadcf, you must specify this flag first.
The SALTCONFIG environment variable must be set before executing wsloadcf.
If a syntax error is detected in the given configuration files, an “ERROR” or “FATAL” message indicating that problem is printed to the console, and no information is updated in the SALTCONFIG file. wsloadcf exits with exit code 1.
A “WARN” message is printed to the console if: (1) configuration files may result in a potential runtime risk or (2) default values are used because they are not specified in the configuration files. “WARN” messages do not interrupt wsloadcf execution.
Upon successful completion, wsloadcf exits with exit code 0. If the SALTCONFIG file is updated, a userlog message is generated.
SALT Deployment File Reference
SALT Web Service Definition File Reference
|