DEFINE CFSTRUCT

 

Use DEFINE CFSTRUCT to define the backup and recovery parameters for a Coupling Facility application structure. This command is valid only on full function WebSphere MQ for z/OS when the queue manager is a member of a queue-sharing group.

Synonym: DEF CFSTRUCT 

DEFINE CFSTRUCT
 
                                    .-CFLEVEL(2)-------.
>>-DEFINE CFSTRUCT(structure-name)--+------------------+-------->
                                    'CFLEVEL(integer)--'
 
   .-DESCR(' ')----------.
>--+---------------------+--+---------------------+------------->
   '-DESCR--(--string--)-'  '-LIKE(cfstruct-name)-'
 
   .-RECOVER (NO)--.  .-NOREPLACE-.
>--+---------------+--+-----------+----------------------------><
   '-RECOVER (YES)-'  '-REPLACE---'

 

Keyword and parameter descriptions

(structure-name)
Name of the Coupling Facility application structure whose backup and recovery parameters you want to define. This is required.

The name:

  • Cannot have more than 12 characters.

  • Must start with an uppercase letter (A through Z).

  • Can include only the characters A through Z and 0 through 9.

The name of the queue-sharing group to which the queue manager is connected is prefixed to the name you supply. The name of the queue-sharing group is always four characters, padded with @ symbols if necessary. For example, if you use a queue-sharing group named NY03 and you supply the name PRODUCT7, the resultant Coupling Facility structure name is NY03PRODUCT7. Note that the administrative structure for the queue-sharing group (in this case NY03CSQ_ADMIN) cannot be used for storing messages.

CFLEVEL(integer)
Specifies the functional capability level for this CF application structure. Value can be one of the following:

1
A CF structure that can be "auto-created" by a queue manager at command level 520.

2
A CF structure at command level 520 that can only be created or deleted by a queue manager at command level 530 or greater. This is the default CFLEVEL for queue managers at command level 530 or greater.

3
A CF structure at command level 530. This CFLEVEL is required if you want to use persistent messages on shared queues (if RECOVER(YES) is set), or for message grouping (when a local queue is defined with INDXTYPE(GROUPID)), or both.

You can only increase the value of CFLEVEL to 3 if all the queue managers in the queue-sharing group are at command level 530 or greater - this is to ensure that there are no latent command level 520 connections to queues referencing the CFSTRUCT.

You can only decrease the value of CFLEVEL from 3 if all the queues that reference the CF structure are both empty (have no messages or uncommitted activity) and closed.

DESCR(string)
Plain-text comment that provides descriptive information about the object when an operator issues the DISPLAY CFSTRUCT command.

The string should contain only displayable characters. The maximum length is 64 characters. In a DBCS installation, it can contain DBCS characters (subject to a maximum length of 64 bytes).

Note:
If characters are used that are not in the coded character set identifier (CCSID) for this queue manager, they might be translated incorrectly if the information is sent to another queue manager.

LIKE(cfstruct-name)
The name of a CFSTRUCT object, whose attributes are used to model this definition. If this field is not filled in, and you do not complete the attribute fields related to the command, the default values are used.

RECOVER
Specifies whether CF recovery is supported for the application structure. Values are:

NO
CF application structure recovery is not supported. (The synonym is N.)

YES
CF application structure recovery is supported. (The synonym is Y.)

You can only set RECOVER(YES) if the structure has a CFLEVEL of 3.

You can only change RECOVER(NO) to RECOVER(YES) if all the queue managers in the queue-sharing group are at command level 530 or greater; this is to ensure that there are no latent command level 520 connections to queues referencing the CFSTRUCT.

You can only change RECOVER(YES) to RECOVER(NO) if all the queues that reference the CF structure are both empty (have no messages or uncommitted activity) and closed.

REPLACE and NOREPLACE
Defines whether the existing definition is to be replaced with this one. This parameter is optional.

REPLACE
The definition should replace any existing definition of the same name. If a definition does not exist, one is created. If you use the REPLACE option, all queues that use this CF structure must be empty and closed. Any CF structure attributes that are not specified on a DEFINE CFSTRUCT call with REPLACE are reset to their default values.

NOREPLACE
The definition should not replace any existing definition of the same name. This is the default.

 

Usage notes

  1. This command cannot specify the CF administration structure (CSQ_ADMIN).

  2. Before any newly defined CF structure can be used by any queues, the structure must be defined in the Coupling Facility Resource Management (CFRM) policy data set.

  3. Only CF structures with RECOVER(YES) defined can be backed up and recovered.

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.