CREATE IMSCON TYPE(IMSPLEX) command
Use the CREATE IMSCON TYPE(IMSPLEX) command to add a communications path from IMS Connect to an IMSplex through a Structured Call Interface (SCI) for communications to other members in the IMSplex.
Subsections:
Environment
- IMS Connect must be active and configured to communicate with the Common Service Layer (CSL) Structured Call Interface (SCI).
- A type-2 command environment with Structured Call Interface (SCI) and Operations Manager (OM) must be active.
Syntax
Keywords
The following keywords are valid for the CREATE IMSCON TYPE(IMSPLEX) command:
- LIKE
- Specifies the existing IMS Connect IMSplex
resource to use as a model. The new resource is created with all of
the same attribute values as the model.
Attributes set explicitly by the CREATE IMSCON TYPE(IMSPLEX) command override the attribute values that are generated from the model. Later changes to the model are not propagated to resources that were created from it.
- NAME
- Specifies the 1- to 5-character name of the IMSplex, as specified
on the IMSPLEX(NAME=) statement of the CSLSIxxx member of the IMS PROCLIB data set of the SCI instance
that is managing communications between IMS Connect
and the IMSplex. The name can consist of alphanumeric characters and
must be unique within IMS Connect.
This keyword is equivalent to the TMEMBER parameter of the IMSPLEX statement in the IMS Connect configuration member.
- SET
- Specifies the attributes of the IMSplex to be created.
If the LIKE keyword is omitted, the required attributes must be specified. If an optional attribute is not specified, IMS Connect uses its default value.
If the LIKE keyword is specified, the attribute values that are specified with the SET keyword override the values that are generated from the model.
- MEMBER
- Specifies a 1- to 8-character alphanumeric name that identifies IMS Connect in
the IMSplex.
IMS Connect registers this name with SCI. SCI uses the name to manage communications between IMS Connect and other IMSplex members, such as Operations Manager (OM), ODBM, or MSC. The name must start with an alphabetic character.
This parameter is required if the LIKE keyword parameter is not specified.
Usage notes
You can issue the CREATE IMSCON TYPE(IMSPLEX) command only through the OM API.
IMS Connect can process IMS Connect type-2 commands only if the IMSplex from which the commands were issued has a status of ACTIVE.
The CREATE IMSCON TYPE(IMSPLEX) command is equivalent to adding an SCI communications path for an IMSplex by specifying the IMSPLEX statement in the IMS Connect configuration PROCLIB member.
At the completion of the CREATE IMSCON TYPE(IMSPLEX) command, IMS Connect starts the communications path to the IMSplex and sets the IMSPLEX status to ACTIVE if it is successful and NOTACTIVE if it is not successful.
Modifications that are made to IMS Connect resources by use of this command are not saved across restarts of IMS Connect.
Equivalent WTOR and z/OS commands
There are no equivalent WTOR and z/OS commands that perform similar functions as the CREATE IMSCON TYPE(IMSPLEX) command.
Output fields
- Short label
- Contains the short label that is generated in the XML output.
- Long label
- Contains the column heading for the output field in the formatted output.
- Keyword
- Identifies the keyword on the command that caused the field to be generated. N/A is displayed for output fields that are always returned. error is displayed for output fields that are returned only in case of an error.
- Meaning
- Provides a brief description of the output field.
| Short label | Long label | Keyword | Meaning |
|---|---|---|---|
| CC | CC | N/A | Completion code that indicates whether IMS Connect was able to process the command for the specified resource. The completion code is always returned. |
| CCTXT | CCText | N/A | Completion code text that briefly explains the meaning of the nonzero completion code. This field is returned only for an error completion code. |
| IMSPLX | IMSplex | N/A | The IMSplex name. The IMSplex name is always returned. |
| MBR | MbrName | N/A | Identifier of the IMS Connect that built the output line. The identifier is always returned. |
Return, reason, and completion codes
An IMS Connect return and reason code is returned to OM by the CREATE IMSCON TYPE(IMSPLEX) command. The OM return and reason codes that might be returned as a result of the CREATE IMSCON TYPE(IMSPLEX) command are standard for all commands that are entered through the OM API.
The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request.
| Return code | Reason code | Meaning |
|---|---|---|
| X'00000000' | X'00000000' | The command completed successfully. The command output contains a line for each resource, which is accompanied by its completion code. For details, see Table 3. |
| X’0C000008’ | X’00002024’ | The LIKE keyword parameter value is invalid. The resource cannot be found. |
| X’0C000008’ | X’00002050’ | The required MEMBER parameter is not specified. |
| X’0C000008’ | X’00002098’ | The specified MEMBER value is too long. IMSplex member name is maximum of 8 characters. |
| X’0C00000C’ | X’00003000’ | The command was successful for some resources but failed for others. The command output contains a line for each resource, which is accompanied by its completion code. |
| X’0C00000C’ | X’00003004’ | The command was not successful for any resource. The command output contains a line for each resource, which is accompanied by its completion code. |
The following table includes an explanation of the completion codes. Errors unique to the processing of this command are returned as completion codes. A completion code is returned for each action against an individual resource.
| Completion code | Completion code text | Meaning |
|---|---|---|
| 0 | The CREATE IMSCON TYPE(IMSPLEX) command completed successfully. | |
| 13 | Resource already exists. | IMSplex already exists. |
| 1A | BPEGETM error | IMS Connect encountered an error while attempting to obtain storage from the BPEGETM service. |
| 1C | FWEB creation failed | IMS Connect encountered an error while attempting to obtain a block of storage of type FWEB from the BPECBGET service. |
| 1D | CVBB creation failed | IMS Connect encountered an error while attempting to obtain a block of storage of type CVBB from the BPECBGET service. |
| 3C | Resource created, start failed | The CREATE command created a
definition of the requested resource in IMS Connect, but the resource
failed to start. The command output might also contain the following
messages, which describe why the resource failed to start:
|
| 3E | Wildcard parameter not supported | The CREATE command does not support wildcard parameters. You must explicitly specify the names of the IMSplex you want to create. |
| 3F | DCTB creation failed | IMS Connect encountered an error while attempting to obtain a block of storage of type DCTB from the BPECBGET service. |
| 40 | Get latch failed | IMS Connect failed to obtain a latch. |
| 41 | NAME value is too long | The specified NAME value is too long. IMSplex name is maximum of 5 characters. |
 53 |
CPEX block creation failed |
IMS Connect encountered an error while attempting to obtain a compliance
extension (CPEX) block from the BPECBGET service. |
Return, reason, and completion codes handled by OM
IMS Connect registers its type-2 command set with OM. When OM detects a command parsing error, OM returns a return code and reason code to the requester, and the command is not routed to IMS Connect.
Clients such as the TSO SPOC send commands to OM by using the CSLOMCMD API. CSLOMCMD return and reason codes are listed in the description of the CSLOMCMD request.
Examples
The following are examples of the CREATE IMSCON TYPE(IMSPLEX) command:
Example 1 for CREATE IMSCON TYPE(IMSPLEX) command
CREATE IMSCON TYPE(IMSPLEX) NAME(PLEX2)
SET(MEMBER(ICON1))IMSplex MbrName CC
PLEX2 HWS1 0 CMD(CRE IMSCON TYPE(IMSPLEX) NAME(PLEX2)
SET(MEMBER(ICON1)))<?xml version="1.0"?>
<!DOCTYPE imsout SYSTEM "imsout.dtd">
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.7.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2014.246 20:20:49.113887</statime>
<stotime>2014.246 20:20:49.165217</stotime>
<staseq>CDB3F4183E71FA55</staseq>
<stoseq>CDB3F4184AFA1FD5</stoseq>
<rqsttkn1>USRT011 10132049</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>HWS1 </master>
<userid>USRT011 </userid>
<verb>CRE </verb>
<kwd>IMSCON </kwd>
<input>CREATE IMSCON TYPE(IMSPLEX) NAME(PLEX2) SET(MEMBER(ICON1))
</input>
</cmd>
<cmdrsphdr>
<hdr slbl="IMSPLEX" llbl="IMSplex" scope="LCL" sort="a" key="1" scroll="no" len="8"
dtype="CHAR" align="left" skipb="no" />
<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no" len="8"
dtype="CHAR" align="left" skipb="no" />
<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT" align="right" skipb="no" />
<hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes"
len="32" dtype="CHAR" align="left" skipb="yes" />
</cmdrsphdr>
<cmdrspdata>
<rsp>IMSPLEX(PLEX2 ) MBR(HWS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout>Example 2 for CREATE IMSCON TYPE(IMSPLEX) command
CREATE IMSCON TYPE(IMSPLEX) NAME(PLEX2) LIKE(PLEX1)IMSplex MbrName CC
PLEX2 HWS1 0 CMD(CRE IMSCON TYPE(IMSPLEX) NAME(PLEX2) LIKE(PLEX1))<?xml version="1.0"?>
<!DOCTYPE imsout SYSTEM "imsout.dtd">
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.7.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2014.246 20:38:14.619891</statime>
<stotime>2014.246 20:38:14.658339</stotime>
<staseq>CDB3F7FD50EF3C46</staseq>
<stoseq>CDB3F7FD5A523CC4</stoseq>
<rqsttkn1>USRT011 10133814</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>HWS1 </master>
<userid>USRT011 </userid>
<verb>CRE </verb>
<kwd>IMSCON </kwd>
<input>CREATE IMSCON TYPE(IMSPLEX) NAME(PLEX2) LIKE(PLEX1) </input>
</cmd>
<cmdrsphdr>
<hdr slbl="IMSPLEX" llbl="IMSplex" scope="LCL" sort="a" key="1" scroll="no"
len="8" dtype="CHAR" align="left" skipb="no" />
<hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="2" scroll="no"
len="8" dtype="CHAR" align="left" skipb="no" />
<hdr slbl="CC" llbl="CC" scope="LCL" sort="n" key="0" scroll="yes" len="4"
dtype="INT" align="right" skipb="no" />
<hdr slbl="CCTXT" llbl="CCText" scope="LCL" sort="n" key="0" scroll="yes"
len="32" dtype="CHAR" align="left" skipb="yes" />
</cmdrsphdr>
<cmdrspdata>
<rsp>IMSPLEX(PLEX2 ) MBR(HWS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout>