Request model definition attributes

The request model definition attribute descriptions are:

Beanname
specifies a bean name, of up to 240 characters, matching the name of the enterprise bean in the XML deployment descriptor. The acceptable characters are A-Z a-z 0-9 . - _ and accented alphabetic characters. For information about entering mixed case information, see CICS® Resource Definition Guide.
Characters outside this range may give unpredictable results. However, you can use an asterisk as the last (or only) character to specify a generic name.

If you specify a generic value for BEANNAME, then you must specify INTFACETYPE(BOTH) and OPERATION(*).

If you specify TYPE as GENERIC, you must specify BEANNAME(*).

For CORBA REQUESTMODELs--that is, if TYPE is CORBA--this field should be blank.

CORBAServer
specifies the name of the destination CORBASERVER for this REQUESTMODEL. The name can be up to 4 characters in length.
The acceptable characters are A-Z a-z 0-9. You can also use an asterisk as the last (or only) character to specify a generic name.

If a generic CORBASERVER is specified, BEANNAME, the CORBA attributes (MODULE and INTERFACE), and the COMMON attributes (OPERATION) must all be an asterisk (*); INTFACETYPE must be BOTH.

If any of the obsolete attribute values (OMGINTERFACE, OMGMODULE and OMGOPERATION) is present in the request model definition, CORBASERVER must be blank.

Description
(Optional.) Specifies a 1- to 30-character description of the resource.
Intfacetype
specifies the Java™ interface type for this REQUESTMODEL:
BOTH
matches either the home or remote interface for the bean. OPERATION must be an asterisk (*).
HOME
specifies that this is the home interface for the bean.
REMOTE
specifies that this is the remote interface for the bean.
NOTAPPLIC
specifies that this attribute is not applicable for this request model definition; that is, the interface type is CORBA.

If you specify TYPE as GENERIC, you must specify INTFACETYPE(BOTH).

If any of the obsolete attribute values (OMGINTERFACE, OMGMODULE and OMGOPERATION) is present in the request model definition, INTFACETYPE must be blank.

Name
Specify a 1- to 8-character name for the request model definition.
Interface
specifies a name, of up to 255 characters, matching the IDL interface name. The acceptable characters are A-Z a-z 0-9 _ : and accented alphabetic characters. For information about entering mixed case information, see CICS Resource Definition Guide.
Characters outside this range may give unpredictable results. However, you can use an asterisk as the last (or only) character to specify a generic name.

Case is significant and should match the original Java or IDL source. However, to comply with CORBA, installation of REQUESTMODELS that specify INTERFACE with values differing only in case from previously installed definitions, will be rejected.

If a generic INTERFACE is specified, the common attributes (OPERATION) must be an asterisk (*).

For EJB REQUESTMODELs--that is, if TYPE is EJB--this field should be blank.

If you specify TYPE as GENERIC, you must specify INTERFACE(*).

If any of the obsolete attribute values (OMGINTERFACE, OMGMODULE and OMGOPERATION) is present in the request model definition, INTERFACE must be blank.

Module
specifies a name, of up to 255 characters, matching the IDL module name (which defines the name scope of the interface and operation).
Characters outside this range may give unpredictable results. However, you can use an asterisk as the last (or only) character to specify a generic name.

Case is significant and should match the original Java or IDL source. However, to comply with CORBA, installation of REQUESTMODELS that specify MODULE with values differing only in case from previously installed definitions, will be rejected.

If you specify a generic value for MODULE, then you must specify INTERFACE(*) and OPERATION(*).

If you specify TYPE as GENERIC, you must specify MODULE(*).

To indicate the default package, leave this field blank and specify a non-blank (but possibly generic) INTERFACE.

For EJB REQUESTMODELs--that is, if TYPE is EJB--this field should be blank.

If any of the obsolete attribute values (OMGINTERFACE, OMGMODULE and OMGOPERATION) is present in the request model definition, MODULE must be blank.

OMGInterface
This attribute is obsolete, but is supported to provide BAS definition support for earlier releases of CICS. If this attribute is present in the request model definition, the following attributes must be blank: If you define a request model with this attribute you can only install it on CICS TS OS/390®, Version 1 Release 3. See CICS Resource Definition Guide for more information.
OMGModule
This attribute is obsolete, but is supported to provide BAS definition support for earlier releases of CICS. If this attribute is present in the request model definition, the following attributes must be blank: If you define a request model with this attribute you can only install it on CICS TS OS/390, Version 1 Release 3. See CICS Resource Definition Guide for more information.
OMGOperation
This attribute is obsolete, but is supported to provide BAS definition support for earlier releases of CICS. If this attribute is present in the request model definition, the following attributes must be blank: If you define a request model with this attribute you can only install it on CICS TS OS/390, Version 1 Release 3. See CICS Resource Definition Guide for more information.
Operation
specifies a name, of up to 255 characters, matching the IDL operation or an IDL representation of the bean method signature. The acceptable characters are A-Z a-z 0-9 _ and accented alphabetic characters. For information about entering mixed case information, see CICS Resource Definition Guide.
However, you can use an asterisk as the last (or only) character to specify a generic name. Characters outside this range may give unpredictable results. Case is significant and should match the original Java or IDL source. However, to comply with CORBA, installation of REQUESTMODELS that specify OPERATION with values differing only in case from previously installed definitions, will be rejected.

In general, Java method names are mapped to an equivalent IDL name. However, there are cases where this is not possible, for example:

Instead, IDL uses a "mangled" form of the Java name, that is, a valid and unambiguous IDL name derived from the Java name. The OPERATION attribute of the REQUESTMODEL must match the mangled name in this case.

For detailed information about how Java names are mapped to IDL names, see the OMG Java to IDL mapping, published by the Object Management Group (OMG), and available from www.omg.org.

If any of the obsolete attribute values (OMGINTERFACE, OMGMODULE and OMGOPERATION) is present in the request model definition, OPERATION must be blank.

If you specify TYPE as GENERIC, you must specify OPERATION(*).

RESGROUP
(Optional.) Specify the name of an existing resource group to which the definition is to be automatically added.
Transid
defines the 4-character name of the CICS transaction to be used when a new request processor transaction instance is required to process a method request matching the specification of the REQUESTMODEL.

The transaction definition must have as its initial program a JVM program whose JVMClass is com.ibm.cics.iiop.RequestProcessor. It must be installed in all the AORs of the logial EJB server; it need not be installed in listener regions that are not also AORs.

Type
specifies the type of REQUESTMODEL:
GENERIC
matches both enterprise bean and CORBA requests. If you specify TYPE(GENERIC), you must also specify:
  • BEANNAME(*)
  • INTERFACE(*)
  • INTFACETYPE(BOTH)
  • MODULE(*)
  • OPERATION(*)
CORBA
matches CORBA requests as specified by the CORBA attributes (MODULE and INTERFACE). Only the CORBA attributes and OPERATION attribute can be specified; the EJB attributes (BEANNAME and INTFACETYPE) and CICS TS V1R3 attributes (OMGINTERFACE, OMGMODULE and OMGOPERATION) must be blank.
EJB
matches enterprise bean requests as specified by the EJB (BEANNAME and INTFACETYPE). Only the EJB attributes and COMMON attributes (OPERATION) are valid; the CORBA attributes (MODULE and INTERFACE) must be blank.

If any of the obsolete attribute values (OMGINTERFACE, OMGMODULE and OMGOPERATION) is present in the request model definition, TYPE must be blank.

Table 27 shows the attributes that are valid for each type:

Table 27. Attributes valid for each value of the TYPE attribute
TYPE(GENERIC) TYPE(EJB) TYPE(CORBA)
BEANNAME valid valid invalid
INTFACETYPE valid valid invalid
MODULE valid invalid valid
INTERFACE valid invalid valid
OPERATION valid valid valid
User data
(Optional.) Three 8-character fields provided for any site-specific CICSPlex® SM data related to the request model. makes no use of this user data.
Version
(Optional.) Specify an integer in the range 1 through 15. Specify 0CICSPlex SM or leave blank for to assign the first available version id in the range 1 through 15.

Related concepts
Request model resource definitions
CICS Resource Definition Guide
Related tasks
Accessing the BAS request model definitions
Working with the RQMDEF view
Defining request models using BAS
Installing BAS request model definitions
[[ Contents Previous Page | Next Page Index ]]