UPDATE IMSCON TYPE(ALIAS) command
Use the UPDATE IMSCON TYPE(ALIAS) command to set or change the attributes of an IMS alias that is associated with an IMS Open Database Manager (ODBM).
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 UPDATE IMSCON TYPE(ALIAS) command.
- NAME
- Specifies the name of the IMS alias. You can specify a single alias name or a list of alias names separated by commas. Wildcards can be used in the names.
- ODBM
- Specifies the name of the IMS ODBM to be updated. You can specify a single ODBM name or a list of ODBM names separated by commas. Wildcards can be used in the names. This keyword is optional.
- START(ROUTE) | STOP(ROUTE)
- Mutually exclusive keywords that you use to enable
or disable message routing to an IMS ODBM
that is associated with the specified IMS alias.
- START(ROUTE)
- Enables message routing to an IMS ODBM
that is associated with the specified IMS alias.
The alias represents the IMS data
store that the client wants to send a message to. The START(ROUTE)
keyword sets the specified IMS alias
to active so that IMS Connect
can route to that alias.
Whereas the UPDATE IMSCON TYPE(ODBM) command starts communication between the IMS Connect and an IMS ODBM, the UPDATE IMSCON TYPE(ALIAS) command sets the specified IMS alias to active so that IMS Connect can route to that alias.
- STOP(ROUTE)
- Disables message routing to an IMS ODBM
that is associated with the specified IMS alias.
The STOP(ROUTE) keyword sets the specified alias to inactive so that IMS Connect cannot route to that
alias. You can resume routing by specifying the START(ROUTE) keyword.
If you stop routing messages to a particular alias by using the STOP(ROUTE) keyword, and then issue the UPDATE IMSCON TYPE(ODBM) STOP(COMM) command followed by UPDATE IMSCON TYPE(ODBM) START(COMM), the alias status is lost. In other words, the alias will be active again after the UPDATE IMSCON TYPE(ODBM) commands.
Usage notes
You can issue the UPDATE IMSCON TYPE(ALIAS) command only through the Operations Manager (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.
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
The following table lists IMS Connect WTOR (Write to Operator with Reply) and IMS Connect z/OS® commands that perform similar functions as the UPDATE IMSCON TYPE(ALIAS) command.
- IMS Connect WTOR commands are replies to the outstanding IMS Connect reply message.
- IMS Connect z/OS commands are issued through the z/OS (MVS™) interface by using the IMS Connect jobname.
| UPDATE IMSCON TYPE(ALIAS) command | Equivalent IMS Connect WTOR command | Equivalent IMS Connect z/OS command |
|---|---|---|
| UDPATE IMSCON TYPE(ALIAS) NAME(alias_name) ODBM(odbm_name) START(COMM) | STARTIA alias_name odbm_name | UPDATE ALIAS NAME(aliasName) ODBM(odbmName) START(ROUTE) |
| UDPATE IMSCON TYPE(ALIAS) NAME(alias_name) ODBM(odbm_name) STOP(COMM) | STOPIA alias_name odbm_name | UPDATE ALIAS NAME(aliasName) ODBM(odbmName) STOP(ROUTE) |
Output fields
- Short label
- Contains the short label that is generated in the XML output.
- Long label
- Contains the column heading displayed on the TSO SPOC screen.
- Keyword
- Identifies the keyword on the command that caused the field to be generated. N/A (not applicable) is displayed for output fields that are always returned. error is displayed for output fields that are returned only in the case of an error.
- Meaning
- Provides a brief description of the output field.
| Short label | Long label | Keyword | Meaning |
|---|---|---|---|
| ALIAS | AliasName | N/A | The alias name of an IMS data store defined to the instance of ODBM. The alias name is always returned. |
| 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. See Table 4. |
| CCTXT | CCText | error | Completion code text that briefly explains the meaning of the nonzero completion code. This field is returned only for an error completion code. |
| MBR | MbrName | N/A | Identifier of the IMS Connect that built the output line. The identifier is always returned. |
| ODBM | ODBMName | ODBM | Name of the ODBM associated with the alias. |
Return, reason, and completion codes
The return and reason codes that can be returned as a result of the UPDATE IMSCON TYPE(ALIAS) command are standard for all commands 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 UPDATE IMSCON TYPE(ALIAS) command completed successfully. The command output contains a line for each resource, accompanied by its completion code. |
| X'0C00000C' | X'00003000' | The command was successful for some resources but failed for others. The command output contains a line for each resource, 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, accompanied by its completion code. |
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 UPDATE IMSCON TYPE(ALIAS) command completed successfully for the resources. | |
| 10 | NO RESOURCES FOUND | The resource name is unknown to the client that is processing the request. The resource name might have been typed in error or the resource might not be active at this time. If a wildcard was specified in the command, there were no matches for the name. Confirm that the correct spelling of the resource name is specified on the command. |
Examples
Example 1 for UPDATE IMSCON TYPE(ALIAS) command
TSO SPOC input:
UDPATE IMSCON TYPE(ALIAS) NAME(IMS1) ODBM(ODBMA) START(ROUTE)TSO SPOC output:
AliasName MbrName CC ODBMName
IMS1 HWS1 0 ODBMAOM API input:
CMD ( UDPATE IMSCON TYPE(ALIAS) NAME(IMS1) ODBM(ODBMA) START(ROUTE) )OM API output:
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.5.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2010.298 15:34:49.371591</statime>
<stotime>2010.298 15:34:49.372641</stotime>
<staseq>C6C83044FA3C7630</staseq>
<stoseq>C6C83044FA7E1E70</stoseq>
<rqsttkn1>USRID01 10083449</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>HWS1 </master>
<userid>USRID01 </userid>
<verb>UPD </verb>
<kwd>IMSCON </kwd>
<input>UPD IMSCON TYPE(ALIAS) NAME(IMS1) ODBM(ODBMA) START(ROUTE)
</input>
</cmd>
<cmdrsphdr>
<hdr slbl="ALIAS" llbl="AliasName" 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" />
<hdr slbl="ODBM" llbl="ODBMName" scope="LCL" sort="a" key="3"
scroll="yes" len="8" dtype="CHAR" align="left" skipb="no" />
</cmdrsphdr>
<cmdrspdata>
<rsp>ALIAS(IMS1 ) MBR(HWS1 ) CC( 0) ODBM(ODBMA )
</rsp>
</cmdrspdata>
</imsout> Explanation: Message routing to the IMS Open Database (ODBM), ODBMA, associated with the IMS alias, IMS1, has been enabled.