Reference Guide

Oracle SALT Command Reference

The Oracle SALT Command Reference describes system processes and commands delivered with the Oracle SALT software.

Table 1 lists Oracle SALT commands and functions.

Table 1 Oracle SALT Commands and Functions
Name	Description
buildscaclient	Builds processes that call SCA components.
buildscacomponent	Builds SCA components.
`buildscaserver`	Parses SCDL definitions and interfaces and produces a Tuxedo-deployable server and elements.
`GWWS(5)`	Web service gateway server.
`mkfldfromschema, mkfld32fromschema`	The `mkfldfromschema` and `mkfld32fromschema` commands take an XML schema as input and produce a field table.
`mkviewfromschema, mkview32fromschema`	The `mkviewfromschema` and `mkview32fromschema` commands take an XML schema as input and produce a view file.
`scaadmin`	SCA servers management command interpreter
`scapasswordtool`	Manages passwords for Tuxedo authentication in SCA clients
`setSCAPasswordCallback(3c)`	Sets the callback for retrieving a password associated with an identifier in a `<binding.atmi>` element.
tmscd(1)	Command line utility to activate and deactivate service contract discovery
`tmwsdlgen`	WSDL document generator.
tuxscagen	Generates SCA, SCDL, and server side interface files for Tuxedo services.
`wsadmin`	Oracle SALT administration command interpreter.
`wsdlcvt`	WSDL document converter.
`wsloadcf`	Reads SALT Deployment file and other referenced artifacts. Loads a binary SALTCONFIG file.

buildscaclient

Name

buildscaclient – Builds processes that call SCA components.

Synopsis

buildscaclient -c defaultcomponent[-v] [-k] [-o name]
[-s scaroot][-f firstfiles] [-l lastfiles]

Description

This command is used to build client processes that can call SCA components hosted in Tuxedo environments. The command combines files, specified using the -f and -l options, with the SCA and standard Tuxedo ATMI libraries to form a client application. The client application is built using the default C++ language compile command defined for the operating system in use, unless overridden using the CC environment variable.

All specified .c and .cpp files are compiled in one invocation of the compilation system based on the operating system. Users may specify the compiler to invoke by setting the CC environment variable to the name of the compiler. If the CC environment variable is not defined when buildscaclient is invoked, the default C++ language compile command for the operating system is invoked to compile all .c and .cpp files.

You may specify additional options to be passed to the compiler by setting the CFLAGS or the CPPFLAGS environment variables. If CFLAGS is not defined when buildobjclient is invoked, then buildscaclient uses the value of CPPFLAGS, if that variable is defined.

Parameters and Options

buildscaclient supports the following parameters and options:

`-c defaultcomponent`

Required parameter. Indicates which component should be used for this application.

`[-v]`

Specifies that the buildscaclient command should work in verbose mode. In particular, it writes the compile command to its standard output.

`[-k]`

Maintains the generated stubs. buildscaclient generates proxy files that allow dynamic interfacing of clients and references. This is normally compiled and then removed when the proxy is built. This option indicates that the source file should be retained.

Caution:

The generated contents of this file may change from release to release. It is advised that you do not depend on the data structures and interfaces exposed in this file. This option is provided to aid in debugging of build problems.

`[-o name]`

Specifies the name of the client application generated by this command. If the name is not supplied, the application file is named client<.type>, where type is an extension that is dependent on the operating system. For example, on a UNIX system, there would not be a type, but on a Windows system, the type would be .EXE.

`[-s scaroot]`

Specifies the location of SCA root, where the SCDL files for the required components are located. If not set, the APPDIR environment value is used.

`[-f firstfiles]`

Specifies the file to be included first in the compile and link phases of the buildscaclient command. The specified file is included before the SCA libraries are included. There are two ways of specifying a file or files:

Filename Specification	Description
`-f firstfile`	One file is specified
`-f "file1.cpp file2.cpp file3.cpp … "`	Multiple files may be specified if their names are enclosed in quotation marks and are separated using white spaces.

Note:

Filenames that include spaces are not supported.
The -f option may be specified multiple times.

`[-l lastfiles]`

Specifies a file to be included last in the compile and link phases of the buildscaclient command. The specified file is included after the SCA libraries are included. There are two ways of specifying the file, as shown in the following table.

Filename Specification	Description
`-l lastfile`	One file is specified
`-l "file1.cpp file2.cpp file3.cpp … "`	Multiple files may be specified if their names are enclosed in quotation marks and are separated using white spaces.

Note:

Filenames that include spaces are not supported.
The -l option may be specified multiple times.

Environment Variables

Following is a list of environment variables for buildSCAclient:

`TUXDIR`

Finds the SCA libraries and includes files to use when compiling the client applications.

`CC`

Indicates the compiler for all files with .c or .cpp file extensions. If not defined, the default C++ language compile command is invoked to compile all .c and .cpp files, based on the operating system.

`CFLAGS`

Indicates any arguments that are passed as part of the compiler command line for any files with .c or .cpp file extensions. If CFLAGS does not exist in the buildscaclient command environment, the command checks for the CPPFLAGS environment variable.

Note: Arguments passed by the CFLAGS environment variable take priority over the CPPFLAGS variable.

`CPPFLAGS`

Contains a set of arguments that are passed as part of the compiler command line for any files with .c or .cpp file extensions.

This is in addition to the command line option "-I$(TUXDIR)/include" for UNIX systems or the command line option /I%TUXDIR%\include for Windows systems, which is passed automatically by the buildscaclient command. If CPPFLAGS does not exist in the buildscaclient command environment, no compiler commands are added.

`LD_LIBRARY_PATH (UNIX systems)`

Indicates the directories that contain shared objects to be used by the compiler, in addition to the objects shared by the CORBA software. A colon (:) is used to separate the list of directories. Some UNIX systems require different environment variables:

HP-UX systems use the SHLIB_PATH environment variable
AIX systems use LIBPATH

`LIB (Windows systems)`

Indicates a list of directories that contain the library files. A semicolon (;) is used to separate the list of directories.

Portability

This command is available on any platform on which the Oracle SALT environment is supported.

Example

buildscaclient -s /myApplication/scaSrc/uBike 
-c SearchRedBikes

buildscacomponent

Name

buildscacomponent - builds SCA components

Synopsis

buildscacomponent [-v] [-s scaroot] [-f firstfiles] [-l lastfiles] -c compositename[/componentname][,compositename,..]] [-y] [-k] [-h]

Description

buildscacomponent is used to build individual SCA components from source code. The command reads SCDL source, finds the component(s) in the composite(s) file(s) specified, parses the corresponding .componentType file(s) and produces corresponding executable libraries, in the same location as the .componentType files.

The command automatically builds component implementations based on the contents of <implementation.cpp> elements as follows:

The value of /implementation.cpp/@header is used to determine the name of the source and componentType files containing the implementation.

For example, an element such as

<implementation.cpp library="myLib" header="myComponentImpl.h"/>

causes buildscacomponent to look for a myComponentImpl.cpp file and compile it, along with stubs generated from its interface located in a corresponding myComponentImpl.componentType file.

Composites may contain one or more components, and the buildscacomponent command may build one or more composites in one pass. If more than one component is built, the files specified using the -f and -l switches are included in each component. To build a single component, the -c composite/component syntax should be used. This addresses the cases where individual components are made up of specific sets of source code or libraries.

All specified .c and .cpp files are compiled in one invocation of the compilation system for the operating system in use. Users may specify the compiler to be invoked by setting the CC environment variable to the name of the compiler. If the CC environment variable is not defined when buildscacomponent is invoked, the default C++ language compile command for the operating system in use is invoked to compile all .c and .cpp files.

Users may specify options to be passed to the compiler by setting the CFLAGS or the CPPFLAGS environment variable. If CFLAGS is not defined but CPPFLAGS is defined when buildscacomponent is invoked, the CPPFLAGS value is used.

Parameters and Options

buildscacomponentsupports the following parameters and options:

`[-v]`

Specifies that buildscacomponent should work in verbose mode.

`[-s scaroot]`

Specifies the location of the SCA root, where the SCDL file(s) for the component(s) is (are) located, and where the source code of components is processed.

If not specified, the value of APPDIR is used.

`[-f firstfiles]`

Specifies a file to be included first in the compile and link phases of the buildscacomponent command. The specified file is included before the SCA libraries are included. There are two ways of specifying a file or files, as shown in Table 2.

Table 2 File Specification Using [-f firstfiles]
Filename Specification	Definition
`-f firstfile`	One file is specified
`-f "file1.cpp file2.cpp file3.cpp … "`	Multiple files may be specified if their names are enclosed in quotation marks and are separated by white space.

Note: Filenames that include spaces are not supported.
The -f option may be specified multiple times.

`[-l lastfiles]`

Specifies a file to be included last in the compile and link phases of the buildscacomponent command. The specified file is included after the SCA libraries are included. There are two ways of specifying a file, as shown in Table 3.

Table 3 File Specification Using [-l lastfiles]
Filename Specification	Definition
`-l lastfile`	One file is specified
`-l "file1.cpp file2.cpp file3.cpp … “`	Multiple files may be specified if their names are enclosed in quotation marks and are separated by white space.

Note: Filenames that include spaces are not supported.
The -l option may be specified multiple times.

`-c {composite[,composite]|composite/component}`

Specifies the name(s) of the composite(s) processed. The composite(s) is (are) searched in APPDIR or in the SCDL directory specified above with the -s switch. If it cannot be found, the component libraries are not built.

A list of composites may be specified, in which case all the components listed in the composites will be built. If any of the composites cannot be found or an error is detected (incorrect name, composite does not have any ATMI service binding), a warning message is displayed and the user is prompted to confirm whether the command should continue processing or abort.

If the composite/component notation is used, a single component contained in the specified composite is allowed. This notation covers the situation where specific source files specified with -f and -l need to be included in the build process of a component.

`[-y]`

Optionally forces processing of input files, automatically ignoring warnings, such as composites specified using the -c switch but not physically present from the root directory.

`[-k]`

Keeps the generated proxy and wrapper source. buildscacomponent generates proxy and wrapper code with data structures such as the method operation and parameter handling. This is normally compiled and then removed when the component is built. This option indicates that the source file should be kept (to see what the source filename is, use the -v option).

Note:

The generated contents of this file may change from release to release; DO NOT count on the data structures and interfaces exposed in this file. This option is provided to aid in debugging of build problems.

Environment Variables

`TUXDIR`

Finds the SCA libraries and include files to use when compiling the client applications.

`APPDIR`

Indicates the SCA application root location, where the top-level composite should reside.

`CC`

Indicates the compiler to use to compile all files with .c or .cpp file extensions. If not defined, the default C++ language compile command for the operating system in use will be invoked to compile all .c and .cpp files.

`CFLAGS`

Indicates any arguments that are passed as part of the compiler command line for any files with a .c or .cpp file extensions. If CFLAGS does not exist in the buildscacomponent command environment, the buildscacomponent command checks for the CPPFLAGS environment variable.

`CPPFLAGS`

Note: Arguments passed by the CFLAGS environment variable take priority over the CPPFLAGS variable.

Contains a set of arguments that are passed as part of the compiler command line for any files with a .c or .cpp file extensions. This is in addition to the command line option -I$(TUXDIR)/include for UNIX systems or the command line option /I%TUXDIR%\include for Windows systems, which is passed automatically by the buildscacomponent command. If CPPFLAGS does not exist in the buildscacomponent command environment, no compiler commands are added.

`LD_LIBRARY_PATH (UNIX systems)`

Indicates which directories contain shared objects to be used by the compiler, in addition to the objects shared by the CORBA software. A colon (:) is used to separate the list of directories. Some UNIX systems require different environment variables: for HP-UX systems, use the SHLIB_PATH environment variable; for AIX, use LIBPATH.

`LIB (Windows systems)`

Indicates a list of directories within which to find libraries. A semicolon (;) is used to separate the list of directories.

Portability

buildscacomponent is supported on any platform on which the Oracle SALT environment is supported.

Examples

buildscacomponent -f utils.c -c searchInventory,updateItem

buildscaserver

Name

buildscaserver – Builds a Tuxedo server containing SCA component.

Synopsis

-o servername -c composite[,composite][-v][-s scaroot] 
[-w] [-r rmname][-y] [-k] [-t]

Description

buildscaserver is used to build a Tuxedo server that is used to route requests to SCA components previously built with the buildscacomponent command. The command generates a main routine that contains bootstrap routines to route Tuxedo or SCA requests to SCA components, and compiles it to form a server host application. The server host application is built using the default C++ compiler provided for the platform.

If the scdl code contains references or services with <binding.ws> elements, these will automatically be converted into WSDF files for use by the Web Services gateway (GWWS). All SCA servers built using buildscaserver are multi-threaded servers.

Parameters and Options

buildscaserver supports the following parameters and options:

`-o servername`

Required. Specifies the name of the server application generated by this command.

`-c compositename[,compositename]`

Required. Specifies the name of the composite hosted. The composite is searched for starting in APPDIR, or in the SCDL directory specified above with the -s switch. If it is not found, the server is not built. In case you specify a list of composites, then all the listed composites are hosted by the same Tuxedo server.

If any of the composites are not found or an error is detected such as incorrect name or composite does not have any atmi service binding, a warning message is displayed and the user is prompted to confirm whether the command should continue processing or abort.

`[-v]`

Specifies that buildscaserver should work in verbose mode.

`[-s scaroot]`

Specifies the target location of the SCA root, where the SCDL files for the components to be deployed are located.

This directory has a layout suitable to SCA composites and components. Each composite is represented as a directory and contains components in the run-time form, which includes SCDL code and libraries. At run time, the server application uses this directory to find the run-time SCA components. If components are using the Web Services binding, the root location also receives a WSDF definition file.

`[-w]`

Specifies that the generated server will host WebServices binding enabled components. By default, a server hosting ATMI binding enabled components is generated. Both types of servers can host the same actual components simultaneously (i.e. there can exist an ATMI and a WS servers, both hosting the same components previously built using the buildscacomponent command).

`[-r rmname]`

Specifies the resource manager associated with this server. The value rmname must appear in the resource manager table located in $TUXDIR/udataobj/RM on UNIX systems or %TUXDIR%\udataobj\RM on Windows systems. Each entry in this file is of the following form:

rmname:rmstructure_name:library_names Using the rmname value, the entry in $TUXDIR/udataobj/RM or %TUXDIR%\udataobj\RM automatically includes the associated libraries for the resource manager and sets up the interface between the transaction manager and the resource manager. The value TUXEDO/SQL includes the libraries for the Oracle Tuxedo System/SQL resource manager. Other values can be specified once they are added to the resource manager table. If the -r option is not specified, the null resource manager is used, by default.

`[-y]`

Optionally forces processing of input files, automatically ignoring warnings.

`[-k]`

Keeps the server main stub. buildscaserver generates a main stub with data structures such as the service table and a main() function. This is normally compiled and then removed when the server is built. This option indicates that the source file should be retained.

Note: To see the source filename, use the -v option.

Caution:

`[-t]`

Not used in current release.

Environment Variables

`TUXDIR`

Finds the SCA libraries and include files to use when compiling the client applications.

`CC`

Indicates the compiler to use to compile all files with .c or .cpp file extensions. If not defined, the default C++ language compile command is invoked to compile all .c and .cpp files.

`CFLAGS`

Indicates any arguments that are passed as part of the compiler command line for any files with a .c or .cpp file extensions. If CFLAGS does not exist in the buildscaserver command environment, the buildscaserver command checks for the CPPFLAGS environment variable.

Note: Arguments passed by the CFLAGS environment variable take priority over the CPPFLAGS variable.

`CPPFLAGS`

Contains a set of arguments that are passed as part of the compiler command line for any files with a .c or .cpp file extensions.

This is in addition to the command line option "-I$(TUXDIR)/include" for UNIX systems or the command line option /I%TUXDIR%\include for Windows systems, which is passed automatically by the buildscaserver command. If CPPFLAGS does not exist in the buildscaserver command environment, no compiler commands are added.

`LD_LIBRARY_PATH (UNIX systems)`

Indicates the directories that contain shared objects to be used by the compiler, in addition to the objects shared by the CORBA software. A colon (:) is used to separate the list of directories. Some UNIX systems require different environment variables:

HP-UX systems use SHLIB_PATH
AIX systems use LIBPATH

`LIB (Windows only)`

Indicates a list of directories where libraries are available. A semicolon (;) is used to separate the list of directories.

Portability

This command is available on any platform on which the Oracle SALT server environment is supported.

Examples

buildscaserver -o uBikeServer -f utils.c

-d /myApplication/myModules/uBike

-s /myApplication/uBikeComponents/uBike

-c searchInventory,updateItem

Error Reporting

This command checks for the following inconsistencies in the SCDL code and reports error messages if:

at least one syntax error in the SCDL files
none of the composites contain any service with an ATMI binding
at least one composite contains services defining ATMI bindings with incompatible <remoteAccess> elements. <remoteAccess> elements with a value of WorkStation are not supported by this command.
/binding.atmi/@requires contains a legacy value and /binding.atmi/map elements contain values that conflict (for example, the same Tuxedo service name mapped to two or more different methods)

GWWS(5)

Name

GWWS – Web service gateway server.

Synopsis

GWWS SRVGRP="identifier" SRVID=number [other_parms]
CLOPT="-A -- – i InstanceID"

Description

The GWWS server is the Web service gateway for Tuxedo applications, the core component of Oracle 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:

`-i InstanceID`

Specifies the 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 Oracle SALT Deployment File.

Environment Variables

The SALTCONFIG environment variable must be set before the GWWS server is booted. Accesslog(5) can be enabled by setting environment variable TMENABLEALOG=y .

Deprecation

The following SALT 1.1 GWWS parameter is deprecated in the current release.

`-c Config_file`

Specifies the SALT 1.1 configuration file.

Note: Starting with 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.

Diagnostics

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.

Examples

Listing 1 GWWS Description in the UBBCONFIG File

*SERVERS

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"

mkfldfromschema, mkfld32fromschema

The mkfldfromschema and mkfld32fromschema commands take an XML schema as input and produce a field table. This table can be processed by the mkfldhdr or mkfldhdr32 command or is loaded by programs that need it. mkfldfromschema is used with 16-bit FML and mlfld32fromschema is used with 32-bit FML.

These commands have the following restrictions:

Attributes cannot be specified
Restrictions are ignored because their meaning is application-related

Name

mkfldfromschema, mkfld32fromschema – Generates field table from an XML schema

Synopsis

mkfldfromschema {-i schema|-u schemaurl} -b basenumber -o
outputfilemkfld32fromschema {-i schema|-u schemaurl} -b basenumber -o
outputfile

Description

These commands take an XML schema as input and generate a field table. The XML schema may be specified using either the -i option or the -u option. If neither option is specified, the schema is read from standard input.

Parameters and Options

mkfldfromschema and mkfld32fromschema supports the following options:

`-b basenumber`

Adds a *base basenumber line to the generated field table.

`-i schema`

Displays the name of a file containing an XML schema. The -i option cannot be specified in conjunction with the -u option.

`-u schemaurl`

A URL where the input schema is located. The URL must start with http://. The -u option cannot be specified in conjunction with the -i option.

`-o outputfile`

The name of a file that will contain the field table. If this option is not specified, the field table will be written to standard output.

Portability

These commands are available on any platform that supports the Oracle Tuxedo server environment.

mkviewfromschema, mkview32fromschema

The mkviewfromschema and mkview32fromschema commands take an XML schema as input and produce a view file. This file can be processed by the viewc or viewc32 command. mkviewfromschema is used with 16-bit views and mkview32fromschema is used with 32-bit views.

Name

mkviewfromschema, mkview32fromschema – Generates view table from an XML schema

Synopsis

mkviewfromschema {-i schema|-u schemaurl} -o outputfile

mkview32fromschema {-i schema|-u schemaurl} -o outputfile

Description

These commands take an XML schema as input and generate a view file. The XML schema may be specified using either the -i option or the -u option. If neither option is specified, the schema is read from standard input.

Options

mkviewfromschema, mkview32fromschema supports the following options:

`-i schema`

The name of a file containing an XML schema. The -i option cannot be specified in conjunction with the -u option.

`-u schemaurl`

A URL where the input schema is located. The URL must start with http://. The -u option cannot be specified in conjunction with the -i option.

`-o outputfile`

The name of a file that contains the output view file. If this option is not specified, the field table is written to standard output.

Portability

These commands are available on any platform that supports the Oracle Tuxedo server environment.

scaadmin

Name

scaadmin – SCA server management command interpreter

Synopsis

scaadmin [-v]

Description

Use the scaadmin command to dynamically redeploy SCA composites or display statistics and status of individual services. The TUXCONFIG environment variable is used to determine the location where the Tuxedo configuration file is loaded.

This command has no effect on servers that have not been built using the buildscaserver(1) command.

Options

The scaadmin command supports the following option:

`[-v ]`

Causes scaadmin to display the Oracle SALT version number, SALT Patch Level. The command exits after print out.

scaadmin must run on an active node.

Commands

`default [-m machine] [-g groupename] [-i srvid] ] [-s servername]`

Sets the corresponding argument to be the default machine name, groupname, server id, or servername. If the default command is entered with no arguments, the current defaults are printed.

`reload [-m machine] [-g groupname] [-i srvid] ] [-s servername]`

This command dynamically reloads the SCA components hosted on Tuxedo servers. The -m, -g, -i and -s options can be used to restrict the reloaded servers to any combination of machine, group, server id and server name.

`printstats [-m machine] [-g groupname] [-i srvid] [-s servername]`

This command displays the list of services hosted by a server and the associated method, number of queries, and status (active, idle). The -m, -g, -i and -s options can be used to restrict the reloaded servers to any combination of machine, group, server id and server name.

`verbose (v) [{off | on}]`

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 set to off.

`help (h) [{command | all}]`

Prints help messages. If command is specified, the abbreviation, arguments, and description for that command are printed. all causes a description of all commands to be displayed. Omitting all arguments causes the syntax of all commands to be displayed.

`echo (e) [{off | on}]`

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.

`quit (q)`

Terminates the session

Interoperability

The scaadmin command must run on an active node.

Environment Variables

TUXCONFIG

Used to determine the location where the Tuxedo configuration file is loaded.

Portability

scaadmin is supported on any platform that supports the Oracle SALT server environment.

Examples

The following command reloads all the composites hosted by the uBikeServer Tuxedo application server, which was built using the buildscaserver(1) command.

scaadmin

> reload -s uBikeServer

The following command displays statistics on the services offered by the uBikerServer Tuxedo application server, which was built using the buildscaserver(1) command.

scaadmin

> printstats -s uBikeServer

Service            Method             Status      Requests

                                                  Processed

SEARCHINVENTORY    searchInventory    A           37

scapasswordtool

Name

scapasswordtool – Manages passwords for Tuxedo authentication in SCA clients.

Synopsis

scapasswordstore -i passwordidentifier -[a|d]

Description

This command manages the password.store file used by SCA components to refer to Tuxedo-based services.

Passwords are prompted and encrypted. The encrypted version is stored in this file, associated with a clear-text identifier. This command is also used to delete identifier/password pairs from the file.

The password is limited to 40 characters. If standard input is not a terminal, that is, if the user cannot be prompted for a password (as with a Here file, for example), then the APP_PW environment variable is accessed to set the password. If the APP_PW environment variable is not set and standard input is not a terminal, then scapasswordtool prints an error message and exits.

A password.store file is created in the current directory if it does not previously exist.

Parameters and Options

`-i passwordidentifier`

Required. The identifier specified in the <binding> element. SCA components search the password for this element.

`-[a|d]`

The -a option adds an identifier/password pair, whereas the -d option deletes it. An error message is printed out and the command processing is aborted in one of the following situations:

If -a is used to add an already existing identifier
If -d is used to delete a non-existing identifier

Portability

This command is available on any platform that supports the Oracle Tuxedo server environment.

setSCAPasswordCallback(3c)

Name

setSCAPasswordCallback() – Sets the callback for retrieving a password associated with an identifier in a <binding.atmi> element.

Synopsis

#include <tuxsca.h>
void setSCAPasswordCallback(char * (_TMDLLENTRY *)(*disp) (char
*identifier))

Description

setSCAPasswordCallback() allows an SCA component to identify the callback that returns the clear-text password that is passed to the appropriate authentication code.

The function pointer passed on the call to setSCAPasswordCallback() must conform to the specified parameter definition. The _TMDLLENTRY macro is required for Windows-based operating systems to obtain the proper calling conventions between the Tuxedo libraries and your code. On UNIX systems, the _TMDLLENTRY macro is not required because it expands to the null string.

The identifier points to the password identifier passed to the callback function. The callback function then returns a char * that points to the actual clear-text password.

Return Values

The setSCAPasswordCallback() function does not return any data.

Errors

On failure, setSCAPasswordCallback() sets tperrno to one of the following values:

`[TPEPROTO]`

setSCAPasswordCallback() has been called in an improper context.

`[TPESYSTEM]`

An Oracle Tuxedo system error has occurred. The exact nature of the error is written to a log file.

[`TPEOS`]

An operating system error has occurred.

tmscd(1)

Name

tmscd(1) – Activates and deactivates service contract discovery.

Synopsis

tmscd start|stop|status [-e] [-f <file>][id1 [ id2 [ ...]]]

Description

The tmscd command line utility is used to activate and deactivate service contract discovery.

Parameters and Options

tmscd accepts following parameters and options:

`start|stop|status`

Required. Starts, stops, or displays service contract dictionary settings for specific services, or all services if none are specified. A start or stop request for a service that has already activated or deactivated contract discovery is ignored. Effective service information is displayed when handling the requests.

Note: start|stop|status must occur after -e and -f , if either of those options are specified.

`[-e]`

Specifies the service scope as a regular expression.

`[-f <file>]`

The service scope is defined in the given <file>. The file may contain sections to group related definitions together. All entries for a section must be written together line-by-line.

Empty lines or lines starting with '#' are ignored. Lines starting with '*' are section lines. Other lines are "id=content" definitions.

`id1 id2 ...`

Indicates one or more services. If -e is specified, a regular expression is used to match the service name. If -e is not specified, the service name is matched exactly.

Examples

Example 1 - start discovery for TOUPPER, TOLOWER:

tmscd start TOUPPER TOLOWER

Example 2 - start discovery for services started with TO and BR:

tmscd -e start TO.* BR.*

Example 3 - same request as example 1 but via file:

tmscd -f svcfile start id1 id2

Note:

The first found definition is used if section is not provided:

Example 4 - same request as example 2 but via file:

tmscd -e -f svcfile start case4.svcs

Listing 2 shows content of the file named "svcfile".

Listing 2 svcfile Content

# file: svcfile
*case3
id1	= TOUPPER
id2	= TOLOWER

*case4
svcs	= TO.*|BR.*

Diagnostics

tmscd fails if TMMETADATA is not booted or booted using the -r (readonly) option without the -o option.

tmwsdlgen

Name

tmwsdlgen – WSDL document generator.

Synopsis

tmwsdlgen – c wsdf_file [-y] [-o wsdl_file] [-m {pack|raw|mtom}] [-t
{wls|axis}]

Description

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:

the TUXCONFIG environment variable must be set correctly
the relevant Tuxedo application using TMMETADATA must be booted prior to executing tmwsdlgen.

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:

`-c wsdf_file`

Mandatory. Used to specify the SALT WSDF local path.

tmwsdlgen accepts the following optional parameters:

`-o wsdl_file`

Used to specify the output WSDL document file path. If the option is not present, the default file, 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.

`-y`

Overwrites the existing WSDL document file without prompting.

`-m`

Used to specify the WSDL data mapping policy for certain Tuxedo typed buffers. Currently, it applies to the Tuxedo CARRAY buffer type. If 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.

If mtom is specified, CARRAY is mapped to the MTOM SOAP message.

`-t`

This option takes effect only when the -m option is specified in raw mode. It accepts two options, wls or axis:

wls indicates tmwsdlgen generates the WSDL document file in compliance with WebLogic 9.x. The default is wls.
axis indicates the WSDL document file format can be recognized by the Apache Axis toolkit.

Deprecation

The following SALT 1.1 tmwsdlgen parameters are deprecated in the current release.

`-c Config_file`

Mandatory. Used to specify the Oracle SALT Configuration File path.

Note:

In the current SALT release, the SALT 1.1 configuration file is specified as the tmwsdlgen input using the following optional parameters:

`-s`

Used to specify the encoding style used for Web service SOAP messages. Specifies rpc for RPC/encoded style and doc for Doc/literal encoded style. If this option is not present or the specified value is invalid, Doc is the default style.

`-v`

Used to specify the SOAP protocol version that the WSDL file supports. Specify 1.1 for SOAP 1.1 protocol and 1.2 for SOAP 1.2 protocol. If this option is not present or the specified value is invalid, SOAP 1.1 is used as the default.

Note:

In the current SALT release, the SOAP version and message style attribute are specified in the Oracle SALT WSDF.

Diagnostics

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:

WSDF content may result in a potential run-time risk, or
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.

Examples

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

tuxscagen

Name

tuxscagen – Generates SCA, SCDL, and server side interface files for Tuxedo services.

Synopsis

tuxscagen [-s <target-root-directory>][-d <service-name>]
[-C <TUXEDO_cltname>][-u <TUXEDO_username>][-j <java_package_name>]
[-o <output_SCDL_filename>][-i <output_interface_filename>]
[-m <max-intf-arguments>] [-y][-v][-h] [-F] [-c][-g i|a|s]
[-trepository=<filename> | -tinfile=<metarepos.infile> | -tmetadata]

Description

This tool is used to generate interface and SCDL files. The interface files are used for developing the SCA component using ATMI binding, or wrap existing Tuxedo services in an SCA component. The SCDL files are assembly artifacts that help SCA run time to locate the module and services.

Options

tuxscagen supports the following options:

`-s target-root-directory`

Specifies the location of the root directory where the generated SCDL and interface files are located. The directory must exist and with write access permission; if it does not exist, the tool issues an error message and fails.

`-d<service-name>`

Specifies the name of Tuxedo service in the Tuxedo Metadata Repository. If this option is not specified, all services in the repository or in the input file are selected.

Abbreviation: there is no abbreviation for this option

`-C <TUXEDO_cltname>`

The Tuxedo client name. Use cltname as the client name when joining the Tuxedo application.

`-u <TUXEDO_username>`

The Tuxedo user name. Use username as the user name when joining the Tuxedo application. This is required when Tuxedo security level is higher than APP_PW and input method is to retrieve Tuxedo Service Metadata from TUXEDO.TMMETAREPOS Service.

`-j <java_package_name>`

This option generates JAVA interface files. By default, tuxscagen generates C++ header files. If -g is not specified but if -j <java_package_name> is specified then -ga is assumed. However, if -g sub-option i or s is specified, a warning message is displayed.

`-o <output_SCDL_filename>`

This option specifies the output SCDL filenames for single composite and single componentType file. If this option is not specified, then by default, one composite and one componentType are generated for each Tuxedo service. However, if this option is specified with the output filename, only one composite and one componentType file is generated for all the matching Tuxedo services. If the specified <output_SCDL_filename> already exists, an interactive prompt is displayed and requires user input (unless -y is specified). If this option is specified, -F is automatically implied.

`-i <output_interface_filename>`

This option specifies the output interface filenames for single abstract class header file and single class implementation header file. If this option is not specified, then by default, it generates one abstract interface class header file and one implementation class header file.

However, if this option is specified with output interface filename then only one abstract class header file and one implementation header file is generated for all matching Tuxedo services. If the specified <output_interface_filename> already exists, an interactive prompt is displayed and requires user input (unless -y is specified). If this option is specified, -F is automatically implied.

`-m <max-intf-arguments>`

This option specifies the maximum number of arguments allowed in the interface method. If the number of arguments exceeds the specified threshold then a complex data type is used as the input argument for the interface method. The complex data type used is commonj::sdo::DataObjectPtr.

If -m is not specified, the default threshold is 10. If 0 specified, it will always generate using commonj::sdo::DataObjectPtr. If -ga is not specified, this option is ignored.

`-y`

This option suppresses Really overwrite files:<filename> [y, q] ? so that the script can run without user input. This question appears if either or both -o and -i are specified. If both these options are not specified, by default existing files are replaced.

`-v`

This option turns on the verbose mode.

`-h`

If this option is specified, online help is printed and all other options are ignored.

`-F`

Flat File view. If this option is specified, then all the generated files are put in the target root directory. The default is Tree File view.

-c

Generates client-side SCDL. By default tuxscagen generates server-side SCDL, specifying this option changes it to generate client-side SCDL.

`-g a|i|s`

This option is used to specify the files to generate. The sub-options can be combined. The a sub-option is used to generate abstract base class header files. The sub-option i is to generate implementation class header files. Sub-option s is used to generate SCDL files. To generate both header files, specify -gai. To generate all files, specify -gais.

If not specified, -gais is assumed.

`[-trepository=<filename> | -tinfile=<metarepos.infile> | -tmetadata]`

This option specifies the processing type.

If -trepository=<filename> is specified, tuxscagen retrieves service parameter information from the Service Metadata repository file <filename>.If -tinfile=<metarepos.infile> is specified, then tuxscagen retrieves service parameter information from <metarepos.infile>, where the <metarepos.infile> syntax is suitable for input to tmloadrepos. If -tmetadata is specified, tuxscagen retrieves service parameter information from the Tuxedo TMMETADATA server. At most, one -t option can be specified; the default is -tmetadata.

Portability

This tool is available on ny platform on which the Oracle SALT environment is supported.

Example

The following command is used to generate SCDL, interface, and implementation header files from a Tuxedo Metadata Repository file named myrepository in the current working directory. The number of interface method input arguments is limited to 8. If the limit is exceeded, the XSD schema file is still generated.

tuxscagen -s /home/tux/sca -Dname=TRANSFER -gais -m 8 -trepository=myrepository

wsadmin

Name

wsadmin – Oracle SALT administration command interpreter.

Synopsis

wsadmin [-v]

Description

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:

`-v`

Causes wsadmin to display the Oracle SALT version number, SALT Patch Level and license information. wsadmin exits after print out.

wsadmin Commands

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.

`echo(e) [{off | on}]`

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.

`help (h) [command]`

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 run time 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.

-i is mandatory. -s is optional.

`paginate(page) [{off | on}]`

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

`quit (q)`

Terminates the session.

`verbose (v) [{off | on}]`

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.

`! shellcommand`

Escapes to the shell and executes shell command.

`! !`

Repeats previous shell command.

`# [text]`

Specifies comments. Lines beginning with # are ignored.

`<CR>`

Repeats the last command.

Examples

The following command inspects run time statistics for both inbound and outbound service on GW2:

wsadmin> gws -i GW2
GWWS 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
The following command inspects run time 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

Name

wsdlcvt – WSDL document converter.

Synopsis

wsdlcvt -i WSDL_URL -o output_basename [-m] [-v] [-y] [-w]

Description

wsdlcvt is used to convert an existing WSDL 1.1 document to a Metadata Input File, FML32 mapping File and Oracle 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 Oracle SALT product.

JRE 1.5 or higher is required to run wsdlcvt.

Parameters

wsdlcvt accepts the following parameters:

`-i`

Specifies the URL of the input WSDL document. The URL can be a local file path or a downloadable HTTP URL link.

`-o`

Specifies the output files basename. The suffixes shown in Table 4 are appended after the basename:

Table 4 wsdlcvt-Created File Suffixes
Suffix	Output File
`.mif`	Tuxedo Service Metadata Input File
`.fml32`	FML32 Field Table Definition File
`.wsdf`	SALT Web Service Definition File
`.xsd`	The WSDL Document embedded XML Schema File

`wsdlcvt` accepts the following optional parameters:

`-y`

Specifies that all the output destination files are overwritten without prompting if they exist. If this parameter is not specified, a prompt message is output.

`-m`

Specifies that the “xsd:string” data type is mapped to an FML32 typed buffer Tuxedo FLD_MBSTRING data type. If this parameter is not specified, Tuxedo FLD_STRING data type is mapped by default.

`-v`

Specifies that wsdlcvt works in verbose mode. In particular, it shows context information in the message and output context as FML32 field comments.

`-w`

If the given WSDL document is published using Microsoft .NET WCF, specifies this parameter to ensure wsdlcvt can handle it correctly.

Environment Variables

The TUXDIR and LANG environment variables must be set correctly.

The PATH environment variable must be set appropriately to execute “java”.

Diagnostics

Error, warning or information messages are output to standard output.

Examples

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

wsloadcf

Name

wsloadcf – Reads SALT Deployment file and other referenced artifacts. Loads a binary SALTCONFIG file.

Synopsis

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

Description

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:

`-n`

Do validation only without generating the SALTCONFIG file.

`-y`

After checking the syntax, tmloadcf checks whether: (a) the file referenced by SALTCONFIG exists; (b) it is a valid Oracle 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.

`-D`

Used to specify the configuration parsing log level.

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.

`-1`

Turns on the SALT 1.1 compatible mode. To pass the SALT 1.1 configuration file to wsloadcf, you must specify this flag first.

-v

Only takes effect when a SALT 1.1 configuration file is used. This option is used to specify which SOAP version is applied to the generated WSDF file.

-s

Only takes effect when a SALT 1.1 configuration file is used. This option is used to specify which SOAP message style is applied to the generated WSDF file.

Environment Variables

The SALTCONFIG environment variable must be set before executing wsloadcf.

Diagnostics

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 run-time 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.

Reference Guide

Oracle SALT Command Reference

buildscaclient

Name

Synopsis

Description

Parameters and Options

-c defaultcomponent

[-v]

[-k]

[-o name]

[-s scaroot]

[-f firstfiles]

[-l lastfiles]

Environment Variables

TUXDIR

CC

CFLAGS

CPPFLAGS

LD_LIBRARY_PATH (UNIX systems)

LIB (Windows systems)

Portability

Example

See Also

buildscacomponent

Name

Synopsis

Description

Parameters and Options

[-v]

[-s scaroot]

[-f firstfiles]

[-l lastfiles]

-c {composite[,composite]|composite/component}

[-y]

[-k]

Environment Variables

TUXDIR

APPDIR

CC

CFLAGS

CPPFLAGS

LD_LIBRARY_PATH (UNIX systems)

LIB (Windows systems)

Portability

Examples

See also

buildscaserver

Name

Synopsis

Description

Parameters and Options

-o servername

-c compositename[,compositename]

[-v]

[-s scaroot]

[-w]

[-r rmname]

[-y]

[-k]

[-t]

Environment Variables

TUXDIR

CC

CFLAGS

CPPFLAGS

LD_LIBRARY_PATH (UNIX systems)

LIB (Windows only)

Portability

Examples

Error Reporting

See Also

GWWS(5)

Name

Synopsis

Description

-i InstanceID

Environment Variables

Deprecation

-c Config_file

`-c defaultcomponent`

`[-v]`

`[-k]`

`[-o name]`

`[-s scaroot]`

`[-f firstfiles]`

`[-l lastfiles]`

`TUXDIR`

`CC`

`CFLAGS`

`CPPFLAGS`

`LD_LIBRARY_PATH (UNIX systems)`

`LIB (Windows systems)`

`[-v]`

`[-s scaroot]`

`[-f firstfiles]`

`[-l lastfiles]`

`-c {composite[,composite]|composite/component}`

`[-y]`

`[-k]`

`TUXDIR`

`APPDIR`

`CC`

`CFLAGS`

`CPPFLAGS`

`LD_LIBRARY_PATH (UNIX systems)`

`LIB (Windows systems)`

`-o servername`

`-c compositename[,compositename]`

`[-v]`

`[-s scaroot]`

`[-w]`

`[-r rmname]`

`[-y]`

`[-k]`

`[-t]`

`TUXDIR`

`CC`

`CFLAGS`

`CPPFLAGS`

`LD_LIBRARY_PATH (UNIX systems)`

`LIB (Windows only)`

`-i InstanceID`

`-c Config_file`

`-b basenumber`

`-i schema`

`-u schemaurl`

`-o outputfile`

`-i schema`

`-u schemaurl`

`-o outputfile`

`[-v ]`

`default [-m machine] [-g groupename] [-i srvid] ] [-s servername]`

`reload [-m machine] [-g groupname] [-i srvid] ] [-s servername]`

`printstats [-m machine] [-g groupname] [-i srvid] [-s servername]`

`verbose (v) [{off | on}]`

`help (h) [{command | all}]`

`echo (e) [{off | on}]`

`quit (q)`

`-i passwordidentifier`

`-[a|d]`

`[TPEPROTO]`

`[TPESYSTEM]`

[`TPEOS`]

`start|stop|status`

`[-e]`

`[-f <file>]`