QUERY IMSFUNC command
Use the QUERY IMSFUNC command to display one or more or all of the IMS functions that are defined in the IMS function table.
- The function name.
- The function level at which the function was added.
- Whether the function can be dynamically enabled.
- Whether the function can be dynamically disabled.
- Whether it must be enabled globally on all of the IMS systems at the same time.
- Whether DBCTL supports the function.
- Whether DCCTL supports the function.
- Whether batch supports the function.
Environment
| Command / keywords | DB/DC | DBCTL | DCCTL |
|---|---|---|---|
| QUERY IMSFUNC | X | X | X |
| ENABLED | X | X | X |
| NAME | X | X | X |
| SHOW | X | X | X |
Syntax
Keywords
- NAME(functionname)
- Specifies the 1-16 character name of the IMS function to be queried. To see the IMS function names that you can specify on this parameter, see IMS 15 continuous delivery functions.
You cannot specify wildcards for the NAME parameter.
If you omit the NAME parameter, all of the IMS functions in the IMS function table are displayed.
If you omit the NAME parameter and the IMS environment is DCCTL, only IMS Transaction Manager functions are included.
If you omit the NAME parameter and the IMS environment is DBCTL, only database functions are included.
- ENABLED(Y | N)
- You can specify one of the following options:
- Y
- Displays the IMS functions that are enabled.
- N
- Displays the IMS functions that are not enabled.
- SHOW()
- Specifies the fields that are to be returned. For DCCTL, only IMS Transaction Manager functions are included. For DBCTL, only database functions are included. The function name is returned along with the name of the IMS system that created the output and the completion code. If SHOW is not specified, only the function names are returned if the ENABLED filter is not specified.
- ALL
- Returns all fields for the IMS function.
- CANDISABLE
- Indicates whether (Y) or not (N) the IMS function can be disabled by using the UPDATE IMSFUNC command.
- CANENABLE
- Value that indicates whether (Y) or not (N) the IMS function can be enabled by using the UPDATE IMSFUNC command. If the function cannot be enabled, the function is already enabled by default.
- ENABLED
- Indicates whether (Y) or not (N) the IMS function is enabled. If the function can be enabled locally, the "LENBLD" short label is returned. If the function must be enabled globally on all of the IMS systems in an IMSplex at the same time, the "ENBLD" short label is returned. For DCCTL, only IMS Transaction Manager functions are included. For DBCTL, only database functions are included.
- LEVEL
- Displays the current IMS function level and the function level when the function was added regardless of whether the IMS function is enabled or not in the IMS system. The function level format is fullword, decimal number.
- VERSION
- IMS version, release, and modification level, in the format vv.r.m, where vv is the IMS version, r is the IMS release, and m is the IMS modification level.
Usage notes
The ENABLED(N) option for the QUERY IMSFUNC command displays only the functions that are applied to the system but are not yet enabled.
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 appears for output fields that are always returned. error appears for output fields that are returned only in case of an error.
- Scope
- Identifies the scope of the output field.
- Meaning
- Provides a brief description of the output field.
| Short Label | Long Label | Keyword | Scope | Meaning |
|---|---|---|---|---|
| CC | CC | N/A | LCL | Completion code. |
| CCTXT | CCText | Error | LCL | Completion code text that briefly explains the meaning of the nonzero completion code. |
| ENBLD | Enabled | ENABLED | GBL | This IMS function must be enabled on all of the IMS
systems in an IMSplex at the same time.
|
| LALVL | LAddLevel | LEVEL | LCL | The IMS function level when the function was added regardless of whether the function is enabled or not in the IMS system. The function level is a decimal number that represents the PTF that delivered this significant new or changed function. If the function was delivered disabled, it can be enabled dynamically by issuing the UPDATE IMSFUNC NAME(functionname) SET(ENABLED(Y)) command. |
| LCANDSBL | LCanDisable | CANDISABLE | LCL | Whether the function can be disabled.
|
| LCANENBL | LCanEnable | CANENABLE | LCL | Function can be enabled.
|
| LCLVL | LCurrLevel | LEVEL | LCL | The current IMS function level regardless of whether the function is enabled or not in the IMS system. The function level is a decimal number that represents the PTF that delivered the latest significant new or changed function. |
| LENBLD | LEnabled | ENABLED | LCL | Local function enablement.
|
| LVER | LVersion | VERSION | LCL | The current IMS version in the format vv.r.m, where vv is the IMS version, r is the IMS release, and m is the IMS modification level. If the release or modification goes beyond 9, r changes to rr (2 characters) and m changes to mm (2 characters). |
| MBR | MbrName | N/A | N/A | The IMS identifier of the IMS that built the output. The IMS identifier is always returned. |
| NAME | FunctionName | IMSFUNC | LCL | The IMS function name. |
Return, reason, and completion codes
| Return Code | Reason Code | Meaning |
|---|---|---|
| X'00000000' | X'00000000' | Command completed successfully. The command output contains a line for each IMS function and its completion code. |
| X'00000004' | X'00001010' | No IMS functions were found to be returned. The function names that are specified might be invalid, or no IMS functions were specified that match the filter that is specified. |
| X'00000014' | X'00005FF0' | Invalid or unsupported function. The function table does not exist. This might be an internal error, for example, the function table address might be overlaid. |
| Completion Code | Completion Code Text | Meaning |
|---|---|---|
| 0 | Command completed successfully for the IMS function. | |
| 8A | WILDCARD PARAMETER NOT SUPPORTED | The QUERY IMSFUNC command does not support wildcard parameters. You must explicitly specify the names of the IMS functions you query. |
| 146 | INVALID KEYWORD FOR DCCTL | The IMS function keyword that is specified is not valid for a DCCTL system. |
| 229 | INVALID IMS FUNCTION | The IMS function keyword that is specified is invalid. The function is not defined to IMS, or the PTF containing the function has not been applied to this IMS system. |
| 22A | INVALID KEYWORD FOR DBCTL | The IMS function keyword that is specified is not valid for a DBCTL system. |
Example 1 for QUERY IMSFUNC command
In this example, the QUERY IMSFUNC command is used to display the significant new and changed functions that are delivered by IMS. The function level function is enabled by default and cannot be enabled or disabled. The IMSplex consists of IMS1.
QUERY IMSFUNC SHOW(ALL)FunctionName MbrName CC LEnabled LCanEnable LCanDisable LVersion LCurrLevel LAddLevel
FUNCTIONLEVEL IMS1 0 Y N N 15.1.0 00000001 00000001
CMD(QRY IMSFUNC SHOW(ALL))<imsout>
<ctl>
<omname>OM1OM </omname>
<omvsn>1.8.0</omvsn>
<xmlvsn>20 </xmlvsn>
<statime>2017.264 16:03:46.692923</statime>
<stotime>2017.264 16:03:46.693121</stotime>
<staseq>D32C5857C2F3B190</staseq>
<stoseq>D32C5857C3001690</stoseq>
<rqsttkn1>USRT011 10090346</rqsttkn1>
<rc>00000000</rc>
<rsn>00000000</rsn>
</ctl>
<cmd>
<master>IMS1 </master>
<userid>USRT011 </userid>
<verb>QRY </verb>
<kwd>IMSFUNC </kwd>
<input>QUERY IMSFUNC SHOW(ALL) </input>
</cmd>
<cmdrsphdr>
<hdr slbl="NAME" llbl="FunctionName" scope="LCL" sort="a" key="1"
scroll="no" len="16" 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="ENBLD" llbl="Enabled" scope="GBL" sort="n" key="2"
scroll="yes" len="1" dtype="CHAR" align="left" skipb="yes" />
<hdr slbl="LENBLD" llbl="LEnabled" scope="LCL" sort="n" key="0"
scroll="yes" len="1" dtype="CHAR" align="left" skipb="no" />
<hdr slbl="LCANENBL" llbl="LCanEnable" scope="LCL" sort="n" key="0"
scroll="yes" len="1" dtype="CHAR" align="left" skipb="no" />
<hdr slbl="LCANDSBL" llbl="LCanDisable" scope="LCL" sort="n" key="0"
scroll="yes" len="1" dtype="CHAR" align="left" skipb="no" />
<hdr slbl="LVER" llbl="LVersion" scope="LCL" sort="n" key="0"
scroll="yes" len="6" dtype="CHAR" align="right" skipb="no" />
<hdr slbl="LCLVL" llbl="LCurrLevel" scope="LCL" sort="n" key="0"
scroll="yes" len="8" dtype="CHAR" align="right" skipb="no" />
<hdr slbl="LALVL" llbl="LAddLevel" scope="LCL" sort="n" key="0"
scroll="yes" len="8" dtype="CHAR" align="right" skipb="no" />
</cmdrsphdr>
<cmdrspdata>
<rsp>NAME(FUNCTIONLEVEL ) MBR(IMS1) CC( 0) LENBLD(Y) LCANENBL(N)
LCANDSBL(N) LVER(15.1.0) LCLVL(00000001) LALVL(00000001) </rsp>
</cmdrspdata>
</imsout> Example 2 for QUERY IMSFUNC command
You can use this example to understand future, new function levels. This example includes a future function that is named NEWFUNCTION2 that is disabled by default.
The QUERY IMSFUNC command in this example displays the IMS functions that can be enabled by issuing the UPDATE IMSFUNC command. The IMSplex consists of the IMS systems IMS1, IMS2, IMS3, and IMS4.
NEWFUNCTION2 can be dynamically enabled. NEWFUNCTION2 is applied to the IMS1, IMS2, and IMS3 systems, but not enabled. IMS4 does not have the local NEWFUNCTION2 function PTF applied to the system. The function can be enabled by issuing the UPDATE IMSFUNC NAME(NEWFUNCTION2) SET(ENABLED(Y)) command on IMS1, IMS2, and IMS3, but the command fails on IMS4.
QUERY IMSFUNC ENABLED(N) SHOW(ALL)FunctionName MbrName CC LEnabled LCanEnable LCanDisable LVersion LCurrLevel LAddLevel
NEWFUNCTION2 IMS1 0 N Y Y 15.1.0 00000002 00000002
NEWFUNCTION2 IMS2 0 N Y Y 15.1.0 00000002 00000002
NEWFUNCTION2 IMS3 0 N Y Y 15.1.0 00000002 00000002
Example 3 for QUERY IMSFUNC command
You can use this example to understand future new function levels. This example includes the first function (FUNCTIONLEVEL) and three example future new functions that are named NEWFUNCTION2, NEWFUNCTION3, and NEWFUNCTION4.
The local NEWFUNCTION2 function is enabled on IMS1, IMS2, and IMS4. IMS3 does not have the local NEWFUNCTION2 function enabled.
The global NEWFUNCTION3 function is enabled on all IMSs. The command master IMS1 displays the global function NEWFUNCTION3 as enabled, followed by all of the IMS systems displaying lines that NEWFUNCTION3 is enabled locally. A function that is globally enabled is always locally enabled on all of the IMS systems. A function that is globally disabled is always locally disabled on all the IMS systems.
The global NEWFUNCTION4 function is disabled on all of the IMS systems. The command master IMS1 displays the global function NEWFUNCTION4 as disabled, followed by all of the IMS systems displaying lines that NEWFUNCTION4 is disabled locally.
QUERY IMSFUNC SHOW(ENABLED,LEVEL)FunctionName MbrName CC Enabled LEnabled LCurrLevel LAddLevel
FUNCTIONLEVEL IMS1 0 Y 00000004 00000001
FUNCTIONLEVEL IMS2 0 Y 00000004 00000001
FUNCTIONLEVEL IMS3 0 Y 00000004 00000001
FUNCTIONLEVEL IMS4 0 Y 00000004 00000001
NEWFUNCTION2 IMS1 0 Y 00000004 00000002
NEWFUNCTION2 IMS2 0 Y 00000004 00000002
NEWFUNCTION2 IMS3 0 N 00000004 00000002
NEWFUNCTION2 IMS4 0 Y 00000004 00000002
NEWFUNCTION3 IMS1 0 Y
NEWFUNCTION3 IMS1 0 Y 00000004 00000003
NEWFUNCTION3 IMS2 0 Y 00000004 00000003
NEWFUNCTION3 IMS3 0 Y 00000004 00000003
NEWFUNCTION3 IMS4 0 Y 00000004 00000003
NEWFUNCTION4 IMS1 0 N
NEWFUNCTION4 IMS1 0 N 00000004 00000004
NEWFUNCTION4 IMS2 0 N 00000004 00000004
NEWFUNCTION4 IMS3 0 N 00000004 00000004
NEWFUNCTION4 IMS4 0 N 00000004 00000004
FunctionName MbrName CC Enabled LEnabled LCurrLevel LAddLevel
DEDBGT2K IMS1 0 Y 00000002 00000002
FUNCTIONLEVEL IMS1 0 Y 00000001 00000001Example 4 for QUERY IMSFUNC command
You can use this example to understand future, new function levels. This example shows the IMS function level in which support for an old IMS function was deleted. The IMSplex consists of IMS1. In this example, the current IMS function level is 00000022 (x’00000016’), and the old function was added to IMS at IMS function level 00000006 (x’00000006’). The output shows that the function is not locally enabled, it cannot be enabled, and it cannot be disabled. The locally enabled field value of N indicates that this function is not supported.
QUERY IMSFUNC NAME(OLDFUNC1) SHOW(ALL)FunctionName MbrName CC LEnabled LCanEnable LCanDisable LVersion LCurrLevel LAddLevel
OLDFUNC1 IMS1 0 N N N 15.1.0 00000022 00000006
Example 5 for QUERY IMSFUNC command
