1.1.1.2 Defining Service Parameters for SALT

The Oracle Tuxedo Service Metadata Repository interprets parameters as sub-elements encapsulated in an Oracle Tuxedo service typed buffer. Each parameter can have its own data type, occurrences in the buffer, size restrictions, and other Oracle Tuxedo-specific restrictions.

Note:

  • VIEW, VIEW32, X_C_TYPE, or X_COMMON typed buffers

    Each parameter of the buffer should represent a VIEW/VIEW32 structure member.

  • FML or FML32 typed buffers

    Each buffer parameter should represent an FML/FML32 field element that may be present in the buffer.

  • STRING, CARRAY, XML, MBSTRING, and X_OCTET typed buffers

    Oracle Tuxedo treats these buffers uniformly. At most, one parameter is permitted for the buffer to define restrictions (such as buffer size threshold).

  • Custom typed buffers

    Parameters that facilitate describing details about the buffer type.

  • FML32 typed buffersthat support embedded VIEW32 and FML32 buffers

    Embedded parameters provide support.

  • View32 typed buffers that support embedded VIEW32 buffers

    Embedded parameters provide support.

The following table lists the Oracle Tuxedo Service Metadata Repository parameter-level keywords used and interpreted by SALT.

Note:

Metadata Repository parameter-level keywords that are not listed have no relevance to SALT and are ignored when SALT components load the Oracle Tuxedo Service Metadata Repository.

Table 1-2 SALT Usage of Parameter-Level Keyword in Oracle Tuxedo Service Metadata Repository

Parameter-level Keyword SALT Usage
param Specifies the parameter name.
  • VIEW,VIEW32,X_C_TYPE,or X_COMMON

    Specifies the view structure member name in the param keyword.

  • FML,FML32

    Specifies the FML/FML32 field name in the param keyword.

  • STRING,CARRAY, XML, MBSTRING,or X_OCTET

SALT ignores the parameter definitions.

type Specifies the data type of the parameter. Note: SALT does not support dec_t and ptr data types.
subtype Specifies the view structure name if the parameter type is view32. For any other typed parameter, SALT ignores this value.

Note:

SALT requires this value if the parameter type is view32

This keyword is for native Oracle Tuxedo service only.

access The general definition applies for this parameter. To support an Oracle Tuxedo TPFAIL scenario, the access attribute value has been enhanced.

Original values: in, out, inout, noaccess.

New added values: err, inerr, outerr, inouterr.

count The general definition applies for this parameter. For SALT, the value for the count parameter must be greater than or equal to requiredcount.
requiredcount The general definition applies for this parameter. The default is 1. For SALT, the value for the count parameter must be greater than or equal to requiredcount.
size This optional keyword restricts the maximum byte length of the parameter. It is only valid for the following parameter types:

STRING, CARRAY, XML, and MBSTRING

If this keyword is not set, there is no maximum byte length restriction for this parameter.

The value range is [0, 2147483647]

paramschema Specifies the corresponding XML Schema element name of the parameter. It is generated by the SALT WSDL converter. This keyword is for SALT proxy service only. Do not specify this keyword for native Oracle Tuxedo services.
primetype Specifies the corresponding XML primitive data type of the parameter. It is generated by SALT WSDL converter according to SALT pre-defined XML-to-Tuxedo data type mapping rules. This keyword is for SALT proxy service only. Do not specify this keyword for native Oracle Tuxedo services.
RECORD Oracle Tuxedo RECORD typed buffers can describe COBOL copybook information.

Generated COBOL types:

  • RECORD
  • COMP-1
  • COMP-2
  • S9(18)
  • 9(18)
  • S9(9)
  • 9(9)
  • S9(4)
  • S9(10)V9(10)
  • X(1024)
  • @binary=true
inheader Retrieved from the SOAP header portion of the SOAP envelope message received. Message can be a request (native Tuxedo service) or reply (external web service call).
outheader Added to the SOAP header portion of the SOAP envelope message sent. Message can be a reply (native Tuxedo service) or request (external web service call).
inoutheader Combination of inheader and outheader.This parameter is both added to and retrieved from the SOAP header portion of the SOAP message.