UPDATE IMSCON TYPE(CONVERTER) command
Use the UPDATE IMSCON TYPE(CONVERTER) command to refresh one or more IMS Connect XML converters.
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(CONVERTER) command.
- NAME
- Specifies one or more XML converters to be refreshed. You can specify a single converter name or a list of converter names separated by commas. Wildcards can be used in the names.
- OPTION(REFRESH)
- Refreshes the specified XML converters.
Usage notes
You can issue the UPDATE IMSCON TYPE(CONVERTER) 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(CONVERTER) 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(CONVERTER) command | Equivalent IMS Connect WTOR command | Equivalent IMS Connect z/OS command |
|---|---|---|
| UPDATE IMSCON TYPE(CONVERTER) NAME(converter_name) OPTION(REFRESH) | REFRESH CONVERTER NAME(converter_name) | UPDATE CONVERTER NAME(converter_name) OPTION(REFRESH) |
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) appears for output fields that are always returned. error appears 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 |
|---|---|---|---|
| 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. |
| CVTR | Converter | N/A | Name of the XML converter. The 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
The return and reason codes that can be returned as a result of the UPDATE IMSCON TYPE(CONVERTER) 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(CONVERTER) 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. |
| X'0C000014' | X'00005008' | The command processor failed to obtain storage via BPEGETM. |
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(CONVERTER) 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(CONVERTER) command
TSO SPOC input:
UPDATE IMSCON TYPE(CONVERTER) NAME(IMSPHBKD) OPTION(REFRESH)TSO SPOC output:
Converter MbrName CC
IMSPHBKD HWS1 0OM API input:
CMD(UPDATE IMSCON TYPE(CONVERTER) NAME(IMSPHBKD) OPTION(REFRESH))OM API output:
<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.5.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2010.298 16:32:25.126708</statime>
<stotime>2010.298 16:32:25.140495</stotime>
<staseq>C6C83D24A4734B82</staseq>
<stoseq>C6C83D24A7D0F602</stoseq>
<rqsttkn1>USRID01 10093225</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(CONVERTER) NAME(IMSPHBKD) OPTION(REFRESH)
</input>
</cmd>
<cmdrsphdr>
<hdr slbl="CVTR" llbl="Converter" 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="1" 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>CVTR(IMSPHBKD) MBR(HWS1 ) CC( 0) </rsp>
</cmdrspdata>
</imsout> Explanation: The XML converter IMSPHBKD was successfully refreshed.