Control Parameters

The processing of the utility is specified by a series of export or delete control statements defined in the CONTROL DD statement.

The format of each statement is as follows:

  • EXPORT type identifier qualifiers
  • REP field Replacement-Value
  • DEL type identifier

where the identifier is the entity name. Note that identifier and Replacement-Value are case sensitive.

You must specify the identifier name for DEL. The value cannot be an asterisk (*). The same deletion rules apply as in the ISPF deletions: The entry to be deleted cannot be used by any other entity.

Entity Type Values

You must specify an entity type value in an export control statement. The following table shows the entity type values:

Value Description
TRIGGER For trigger definitions only.
RECIPE For recipe definitions only.
BACKEND For BES definitions only.
ESB For ESB definitions only.
BUFFER For buffer definitions only.
MSG For message definitions only.
CONVERTER For conversion-role definitions only.
GROUP For group definitions only.
ALL For all definitions.

Identifier Values

You must specify a value for identifier to identify an entry. The identifier is the ID value of a specific entry:

  • An identifier must be entered.
  • If the type is all, the identifier must be an asterisk (*).

Qualifier Values

A qualifier can be entered depending on the type specified. If no qualifiers are entered, the default is ALL.

If type is all, the default qualifier value is ONLY.

A qualifier value that does not apply to type is ignored.

The following table shows the definition qualifier values:

Value Description
ALL Exports all the related definitions of the selected type.
ONLY Exports only the selected type definition and does not export the related structure definitions.
BUF Exports the related buffer definitions for the selected type.
MSG Exports the related message definitions for the selected type.
CVR Exports the related Conversion Rule definitions for the selected type.
BES Exports the related BES definitions for the selected type.
TRN Exports the related ESB definitions for the selected type.
GRP Exports the related Group definitions for the selected type.

REP Control Parameter

The REP control parameter provides flexibility to administrators and allows you to manage environmental specific information when moving configuration entities from TEST to QA to Production. The following are the only entity field names allowed to be specified when creating an export file for migration. The REP statement must follow an EXPORT statement and applies only to the previously specified EXPORT ENTITY type.

The following table shows the replaceable fields:

ENTITY Type Field Name Description
BACKEND Intf-Id Interface Id field
ESB URL Primary URL definition
URL-ECF EMS Connection Factory URL definition
RECIPE BES-Name Back-end system name specified for endpoints
BES-ALT-Name Back-end system name specified for endpoints
CICS-System-Name CICS AOR routing system identifier
ESB ESB name specified for endpoints
Listen-To The subject or destination name of the recipe to listen to
Publish-To The subject or destination name of the recipe to publish to.
Error-To The error subject or destination name of the recipe to publish to.
Trace-Lvl The user trace debug level for an individual recipe. Valid range: 0 through 5.
TRIGGER ESB ESB name specified for endpoints.
Publish-To The subject or destination name of the trigger to publish to.
Publish-To-Sec The second subject or destination name of the trigger to publish to.
Reply-To The reply subject or destination name for the trigger service.
Error-To The error subject or destination name of the trigger to publish to.
Trace-Lvl The user trace debug level for an individual trigger. Valid range: 0 through 5.

Examples

Here are a few examples:

  • To export a recipe definition named rcp1 and all its related structures:

    EXPORT RECIPE rcp1

  • To export a recipe definition named rcp1 and all its related but completely qualified structures instead of accepting the default qualifier ALL:

    EXPORT RECIPE rcp1 BUF MSG CVR BES TRN GRP

  • To export an entire file:

    EXPORT ALL * ONLY

    RVY3CFUT with the parameter -N has the same capability.

  • To export all ESB definitions only:

    EXPORT ESB * ONLY

  • To delete a recipe definition named rcp1 and all its related structures:

    DEL RECIPE rcp1

  • To delete a buffer definition named buf2 and all its related structures:

    DEL BUFFER buf2