REQUESTMODEL definition attributes

You can specify generic values for some of the attributes in a request model definition. A generic value consists of:
  • An asterisk (*)
  • Or a string consisting of the acceptable characters for the attribute, followed by an asterisk.
A generic attribute matches more than one value in a request: the characters preceding the asterisk are matched exactly, and the remaining characters are ignored. For example:
  • A generic attribute of get_* matches get_firstname and get_lastname, but not set_firstname or getName
  • A generic attribute of * matches all possible values in a request.
Read syntax diagramSkip visual syntax diagram
>>-REQUESTMODEL(name)--GROUP(groupname)------------------------->

                          .-TRANSID(CIRP)--------.   
>--+-------------------+--+----------------------+-------------->
   '-DESCRIPTION(text)-'  '-TRANSID(transaction)-'   

>--CORBASERVER(corbaserver)------------------------------------->

   .-TYPE(GENERIC)--| Attributes for TYPE(GENERIC) |-.   
>--+-------------------------------------------------+---------><
   +-TYPE(EJB)--| Attributes for TYPE(EJB) |---------+   
   '-TYPE(CORBA)--| Attributes for TYPE(CORBA) |-----'   

Attributes for TYPE(GENERIC)

|--BEANNAME(*)--INTFACETYPE(BOTH)--INTERFACE(*)--MODULE(*)--OPERATION(*)--|

Attributes for TYPE(EJB)

|--+-BEANNAME(bean)--+-INTFACETYPE(BOTH)---+--+-OPERATION(operation)-+-+--|
   |                 +-INTFACETYPE(HOME)---+  '-OPERATION(*)---------' |   
   |                 '-INTFACETYPE(REMOTE)-'                           |   
   '-BEANNAME(generic bean)--INTFACETYPE(BOTH)--OPERATION(*)-----------'   

Attributes for TYPE(CORBA)

|--+-+----------------+--+-INTERFACE(interface)--+-OPERATION(operation)-+-+-+--|
   | '-MODULE(module)-'  |                       '-OPERATION(*)---------' | |   
   |                     '-INTERFACE(*)--OPERATION(*)---------------------' |   
   '-MODULE(generic module)--INTERFACE(*)--OPERATION(*)---------------------'   

BEANNAME(bean)
specifies a bean name, of up to 240 characters, matching the name of the enterprise bean in the XML deployment descriptor.
Acceptable characters:
A-Z a-z 0-9 . - _
You can also use accented alphabetic characters. For information about entering mixed case information, see Entering mixed case attributes.
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(*).

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

CORBASERVER(corabserver)
specifies the name of the destination CORBASERVER for this REQUESTMODEL. The name can be up to 4 characters in length.
Acceptable characters:
A-Z a-z 0-9
For information about entering mixed case information, see Entering mixed case attributes.
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(text)
You can provide a description of the resource you are defining in this field. The description text can be up to 58 characters in length. There are no restrictions on the characters that you can use. However, if you use parentheses, ensure that for each left parenthesis there is a matching right one. If you use the CREATE command, for each single apostrophe in the text, code two apostrophes.
GROUP(groupname)
Every resource definition must have a GROUP name. The resource definition becomes a member of the group and is installed in the CICS system when the group is installed.
Acceptable characters:
A-Z 0-9 $ @ #
Any lower case characters you enter are converted to upper case.

The GROUP name can be up to eight characters in length. Lowercase characters are treated as uppercase characters. Do not use group names beginning with DFH, because these characters are reserved for use by CICS.

INTFACETYPE({BOTH|HOME|REMOTE})
specifies the Java™ interface type for this REQUESTMODEL:
BOTH
matches either the home or component 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 component interface for the bean.

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

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

INTERFACE(interface)
specifies a name, of up to 255 characters, matching the IDL interface name.
Acceptable characters:
A-Z a-z 0-9  _
You can also use accented alphabetic characters. For information about entering mixed case information, see Entering mixed case attributes.
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 any of the obsolete attribute values (OMGINTERFACE, OMGMODULE and OMGOPERATION) is present in the request model definition, INTERFACE must be blank.

MODULE(module)
specifies a name, of up to 255 characters, matching the IDL module name (which defines the name scope of the interface and operation).
Acceptable characters:
A-Z a-z 0-9  _
You can also use accented alphabetic characters. For information about entering mixed case information, see Entering mixed case attributes.
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(*).

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 compatibility with earlier releases of CICS®. For more information, see Obsolete attributes.
If this attribute is present in the request model definition, the following attributes must be blank:
  • BEANNAME
  • CORBASERVER
  • INTFACETYPE
  • INTERFACE
  • OPERATION
  • TYPE
OMGMODULE(text)
This attribute is obsolete, but is supported to provide compatibility with earlier releases of CICS. For more information, see Obsolete attributes.
If this attribute is present in the request model definition, the following attributes must be blank:
  • BEANNAME
  • CORBASERVER
  • INTFACETYPE
  • INTERFACE
  • OPERATION
  • TYPE
OMGOPERATION
This attribute is obsolete, but is supported to provide compatibility with earlier releases of CICS. For more information, see Obsolete attributes.
If this attribute is present in the request model definition, the following attributes must be blank:
  • BEANNAME
  • CORBASERVER
  • INTFACETYPE
  • INTERFACE
  • OPERATION
  • TYPE
OPERATION(operation)
specifies a name, of up to 255 characters, matching the IDL operation or a Java-to-IDL mangled representation of the bean or CORBA stateless object's method signature.
Acceptable characters:
A-Z a-z 0-9  _
You can also use accented alphabetic characters. For information about entering mixed case information, see Entering mixed case attributes.
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:
  • Java method names that contain characters which are not permitted in IDL names.
  • Overloaded Java method names.
  • Java method names that begin with get and set.
Instead, IDL uses a "mangled" form of the Java method name—that is, a valid and unambiguous IDL name derived from the Java method name. The OPERATION attribute of the REQUESTMODEL must match the mangled name in this case.

You can use the CREA supplied transaction to manage REQUESTMODEL definitions for enterprise beans. CREA creates REQUESTMODEL definitions with correctly-mangled method names in the OPERATION field.

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.

REQUESTMODEL(name)
specifies the 8–character name of this request model definition.
Acceptable characters:
A-Z a-z 0-9
For information about entering mixed case information, see Entering mixed case attributes.
Do not use names beginning with DFH, because these characters are reserved for use by CICS.
TRANSID(transaction)
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({GENERIC|CORBA|EJB})
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 1 shows the attributes that are valid for each type:
Table 1. 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