Start of change

Specifying feature toggles

New features are continually delivered to in-service CICS® releases to enhance CICS capabilities. Usually, these features are disabled by default. To enable and use these features in your CICS region, you must set up one or more feature toggle configuration files. In the feature toggle configuration file, you can define feature toggles to switch features on or off. For some features, you can also specify feature configuration options.

Before you begin

A list of features that you can choose to install and configure in your CICS region is available in Toggle-enabled features, support by release. Additional features might also be made available and described in APARs. What new features are available for enablement depends on the APARs that have been applied to your CICS system.

About this task

There are two types of configuration files where you can define feature toggles and their options: a group-level file for setting up a collection of regions, and a region-level file. Both files are optional. If neither is present, default values are used. See the topics that describe individual toggle-enabled features for default values.

The group-level file is typically used to specify which features are enabled in a group of regions. This file can also be used to prevent one or more toggle settings or configuration options from being set by region-level files.

The region-level file is typically used to try out a feature in a test region before it is put into production.

The configuration files are read at CICS startup, immediately after system initialization reads the SIT. The group-level file is read first, followed by the region-level file. Options read in the region-level file will override those set in the group-level file except those that are specified with the parameter finalize.

A feature configuration file specifies feature toggles and feature configuration options. A feature toggle takes the following form:
[finalise] com.ibm.cics.component.feature = {true|false}
A feature can have one or more configuration options. You can specify a feature configuration option in the form:
[finalise] com.ibm.cics.component.feature.config_property = value
The value can be a number, string, or boolean.
Tip:
  • You can use a line-continuation character \ at the point you want the line to break. If a \ character is required in either a name or value, double the \ character to escape line continuation.
  • You can use a hash character # at the start of a line to specify a comment line.

The optional parameter finalize can be used in the group-level file to prevent a region-level file from changing the toggle setting or option. For example, if you have given developers access to their region-level file, you can prevent them from using certain features.

Procedure

Example

This is an example feature toggle configuration file:

# Feature Toggle File 
com.ibm.cics.bms.ids=true  1 
com.ibm.cics.bms.ids.vtamignore=false  2 
com.ibm.cics.bms.ids.action=ABEND  3 

 1  switches on the BMS 3270 Intrusion Detection Service.

 2  and  3  are configuration options for the feature.

What to do next

After the CICS region is started, you can see the feature toggles and their values in message DFHPA1956I in the CICS log. The message indicates what settings have been read in and stored from the feature toggle configuration file, but it does not indicate whether and how the feature toggles are being used.

Restriction: Feature toggles are not displayed by CPSM.


configfeaturetoggle.html | Timestamp icon Last updated: Sunday, 4 June 2017
End of change