IMS Connect support for command requests to Operations Manager (OM)

IMS Connect (ICON) clients can send command requests to the Operations Manager (OM) to be processed by components in the IMSplex such as IMS, ODBM, and ICON.

Sending a command request to OM is similar to sending a transaction to IMS. ICON clients build the command request using the IMS request message (IRM) header format.

The following are command-related settings that user-written ICON clients must set in the command request:

Set the user message exit IRM_ID field to HWSCSLO0 or HWSCSLO1 string values ‘*HWSCSL*’ or ‘*HWSCS1*’.
Set the destination IRM_IMSDESTID to the IMSplex name connected to the ICON. The IMSplex name can be found in the TMEMBER= parameter of the IMSPLEX statement in the ICON HWSCFGxx configuration member.
Set the application data to the command string 'CMD(command string)' such as 'CMD(QRY IMSCON TYPE(PORT) NAME(*) SHOW(STATUS))'.

ICON API for Java clients can issue the following method calls by setting the following fields:

Set the user message exit by issuing TmInteraction.setImsConnectUserMessageExitIdentifier(exit name). Exit name can be either TmInteraction.IMS_CONNECT_USER_MESSAGE_EXIT_IDENTIFIER_FOR_HWSCSLO0 or TmInteraction.IMS_CONNECT_USER_MESSAGE_EXIT_IDENTIFIER_FOR_HWSCSLO1.
Set the destination by issuing TmInteraction.setImsDatastoreName(IMSplex name).
Set Interaction type to command by issuing TmInteraction.setInteractionTypeDescription(TmInteraction.INTERACTION_TYPE_DESC_TYPE2_COMMAND).
Set the application data as shown below:

String inputMessage = "CMD(command string)";

short inputMessageLength = (short) (inputMessage.length() + 4);

ByteBuffer inputMessageInByteFormat = ByteBuffer.allocate(inputMessageLength);

inputMessageInByteFormat.position(0);

inputMessageInByteFormat.putShort((short) inputMessageLength);

inputMessageInByteFormat.putShort((short) 0);

inputMessageInByteFormat.put(inputMessage.getBytes(Charset.forName("CP1047")));InputMessage im = commandTi.getInputMessage();

im.setInputMessageData(inputMessageInByteFormat.array());

Example command request message for command QRY IMSCON TYPE(PORT) NAME(*) SHOW(STATUS) using exit HWSCSLO1 and destination PLEX1:

Offset 0 4 8 C EBCDIC Data
------ ----------------------------------- ------------------
+000000 000000E3 00A80500 5CC8E6E2 C3E2F15C |...T.y..*HWSCS1*|
+000010 00000000 00631000 C3D3C9C5 D5E3F0F1 |........CLIENT01|
+000020 00208040 40404040 40404040 D7D3C5E7 |...         PLEX|
+000030 F1404040 40404040 40404040 E4E2D9E3 |1           USRT|
+000040 F0F0F140 E2E8E2F1 40404040 5C5C5C5C |001 SYS1    ****|
+000050 5C5C5C5C D9C1C3C6 C1D7D5D4 40404040 |****RACFAPNM    |
+000060 40404040 40404040 40404040 40404040 |                |
+000070 40404040 40404040 40404040 00000000 |            ....|
+000080 00000000 00000000 00000000 00000000 |................|
+000090 00000000 00000000 00000000 00000000 |................|
+0000A0 00000000 00000000 00000000 00330000 |................|
+0000B0 C3D4C44D D8D9E840 C9D4E2C3 D6D540E3 |CMD(QRY IMSCON T|
+0000C0 E8D7C54D D7D6D9E3 5D40D5C1 D4C54D5C |YPE(PORT) NAME(*|
+0000D0 5D40E2C8 D6E64DE2 E3C1E3E4 E25D5D00 |) SHOW(STATUS)).|
+0000E0 040000                              |...             |

Example command response message:

Offset 0 4 8 C EBCDIC Data
------ ----------------------------------- ------------------
+000000 000010E7 4C6FA794 9340A585 99A28996 |...X<?xml versio|
+000010 957E7FF1 4BF07F6F 6E4C5AC4 D6C3E3E8 |n="1.0"?><!DOCTY|
+000020 D7C54089 94A296A4 A340E2E8 E2E3C5D4 |PE imsout SYSTEM|
+000030 407F8994 A296A4A3 4B84A384 7F6E4C89 | "imsout.dtd"><i|
+000040 94A296A4 A36E4C83 A3936E4C 96949581 |msout><ctl><omna|
+000050 94856ED6 D4F1D6D4 4040404C 61969495 |me>OM1OM   </omn|
+000060 8194856E 4C9694A5 A2956EF1 4BF84BF0 |ame><omvsn>1.8.0|
+000070 4C619694 A5A2956E 4CA79493 A5A2956E |</omvsn><xmlvsn>|
...
+000FE0 827E7FA8 85A27F40 616E4C61 83948499 |b="yes" /></cmdr|
+000FF0 A2978884 996E4C83 948499A2 978481A3 |sphdr><cmdrspdat|
+001000 816E4C99 A2976ED7 D6D9E34D F9F9F9F9 |a><rsp>PORT(9999|
+001010 40404040 5D40D4C2 D94DC8E6 E2F14040 |    ) MBR(HWS1  |
+001020 40404040 40404040 40405D40 C3C34D40 |          ) CC( |
+001030 4040F05D 40E2E3E3 4DC1C3E3 C9E5C55D |  0) STT(ACTIVE)|
+001040 404C6199 A2976E4C 99A2976E D7D6D9E3 | </rsp><rsp>PORT|
+001050 4DF9F9F9 F8404040 405D40D4 C2D94DC8 |(9998    ) MBR(H|
+001060 E6E2F140 40404040 40404040 4040405D |WS1            )|
+001070 40C3C34D 404040F0 5D40E2E3 E34DC1C3 | CC(   0) STT(AC|
+001080 E3C9E5C5 5D404C61 99A2976E 4C99A297 |TIVE) </rsp><rsp|
+001090 6ED7D6D9 E34DF5F5 F5F5C440 40405D40 |>PORT(5555D   ) |
+0010A0 D4C2D94D C8E6E2F1 40404040 40404040 |MBR(HWS1        |
+0010B0 40404040 5D40C3C3 4D404040 F05D40E2 |    ) CC(   0) S|
+0010C0 E3E34DC1 C3E3C9E5 C55D404C 6199A297 |TT(ACTIVE) </rsp|
+0010D0 6E4C6183 948499A2 978481A3 816E4C61 |></cmdrspdata></|
+0010E0 8994A296 A4A36E                     |imsout>         |