INQUIRE FEATUREKEY

Retrieves the value of a feature toggle.

Syntax

INQUIRE FEATUREKEY

Read syntax diagramSkip visual syntax diagram INQUIRE FEATUREKEY( data-value) VALUE( data-area) FILEPATH( data-area)

Conditions: NOTAUTH, NOTFND

NOHANDLE, RESP, and RESP2 are common options that can be added to all EXEC CICS commands to process error conditions. They are not explicitly included in the command syntax diagram and option descriptions. For information about these common options and EXEC CICS command syntax, see EXEC CICS command format and programming considerations. For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

Description

The INQUIRE FEATUREKEY command returns the value of the feature toggle with the specified name. Feature toggles are used to enable and set configuration options for toggle-enabled features. You can use INQUIRE FEATUREKEY to inquire the enablement state and configuration settings for any toggle-enabled feature. Supported toggle-enabled features are listed in Feature toggles. Follow the links in the feature list table to locate the information about a specific toggle-enabled feature.

Browsing

You can browse through all the feature toggles that are specified for your region by using the browse options on INQUIRE FEATUREKEY commands: START, NEXT, and END. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

Options

FEATUREKEY(data-value)
Specifies the 1- to 255-character name of the feature toggle.
VALUE(data-area)
Returns the 1- to 255-character value of the specified feature toggle.
FILEPATH(data-area)
Returns a 255-character data area containing the path to the feature toggle configuration file that defines the feature toggle setting that is in effect in the CICS® region.

Conditions

NOTAUTH
RESP2 values:
100
The user associated with the issuing task is not authorized to use this command.
NOTFND
RESP2 values:
1
The feature toggle with the specified name does not exist.
5
No feature toggles are defined.

Example

For example, the enablement of the BMS 3270 Intrusion Detection Service is controlled by the feature toggle, com.ibm.cics.bms.ids={true|false}. To inquire whether this feature is toggled on for use in the CICS region, issue the following command:
EXEC CICS INQUIRE FEATUREKEY('com.ibm.cics.bms.ids')
To inquire the configuration options that have been set for this feature, issue the following commands:

EXEC CICS INQUIRE FEATUREKEY('com.ibm.cics.bms.ids.action')
EXEC CICS INQUIRE FEATUREKEY('com.ibm.cics.bms.ids.vtamignore')