Variables and properties files definition

When you define variables and their associated properties files, use these rules to ensure that variable substitution can occur successfully.

Defining variables in a properties file

The following rules apply to the definition of variables in a properties file:
  • Valid characters in a variable name are uppercase and lowercase letters, numbers 0 - 9, periods, underscores, and hyphens. Variable names are limited to 255 characters.
  • Properties files can exist in a CICS® bundle or an application binding. They must be in the root of the project, and must be named variables.properties.
  • You can supply a separate properties file to resolve stand-alone bundles, but this option is not supported for applications. There are no restrictions on the name of a properties file when used with a stand-alone bundle.
  • Properties files follow the standard format for Java™ properties files, and must be encoded in ISO-8859-1. For more information, see Java properties files in Java Platform, Standard Edition 7 API Specification.
  • Any variable that is used in a bundle must be defined in the properties file for that bundle. When substituted into the resource definition, the value that is supplied in the bundle must result in a valid value for that attribute.
  • Variable values must not refer to other variables. For example, hlq=${prod.hlq} is not valid.
  • If a variable is defined more than once in a properties file, the last instance is used.

Referencing variables in bundle parts

The following rules apply to the reference of variables in bundle parts:
  • Variable names are delimited by ${ and } characters.
  • Variables are allowed in any CICS bundle part, including in attributes or elements of a bundle part.
  • There is no limit to the number of variables that can be placed in an attribute or tag.
  • Variables cannot be nested, and they must not be used as part of a CICS resource definition name.