TSMODEL definition attributes

Read syntax diagramSkip visual syntax diagram
>>-TSMODEL(name)--GROUP(groupname)--+-------------------+------->
                                    '-DESCRIPTION(text)-'   

   .-LOCATION(AUXILIARY)-.                         
>--+---------------------+--+------------------+---------------->
   '-LOCATION(MAIN)------'  +-PREFIX(prefix)---+   
                            '-XPREFIX(xprefix)-'   

   .-RECOVERY(NO)--.   
>--+---------------+-------------------------------------------->
   '-RECOVERY(YES)-'   

>--+---------------------------------------------------+-------->
   +-POOLNAME(pool)------------------------------------+   
   '-REMOTESYSTEM(connection)-+----------------------+-'   
                              +-REMOTEPREFIX(prefix)-+     
                              '-XREMOTEPFX(xprefix)--'     

   .-SECURITY(NO)--.   
>--+---------------+-------------------------------------------><
   '-SECURITY(YES)-'   

DESCRIPTION(text)
You can provide a description of the resource you are defining in this field. The description text can be up to 58 characters in length. There are no restrictions on the characters that you can use. However, if you use parentheses, ensure that for each left parenthesis there is a matching right one. If you use the CREATE command, for each single apostrophe in the text, code two apostrophes.
GROUP(groupname)
Every resource definition must have a GROUP name. The resource definition becomes a member of the group and is installed in the CICS system when the group is installed.
Acceptable characters:
A-Z 0-9 $ @ #
Any lower case characters you enter are converted to upper case.

The GROUP name can be up to eight characters in length. Lowercase characters are treated as uppercase characters. Do not use group names beginning with DFH, because these characters are reserved for use by CICS.

LOCATION({AUXILIARY|MAIN})
specifies whether the queue is to be held in auxiliary or main storage:
AUXILIARY
Queues matching this model are to be held on auxiliary storage. Whatever is specified on the API request is disregarded.
MAIN
Queues matching this model are to be held in main storage. Whatever is specified on the API request is disregarded.
Note:
  1. TSMODEL definitions created using the Migrate command have their location attribute set to the default value AUXILIARY.
  2. LOCATION is ignored for remote TSMODELs and shared TS pool models. Using LOCATION on a remote entry allows the same definition to be installed in both a local and remote region. See Shared resources for intercommunication.
POOLNAME(pool)
specifies the 8-character name of the shared TS pool definition that you want to use with this TSMODEL definition. The name can be up to eight characters in length.
Acceptable characters:
A-Z 0-9 $ @ # -
Any lowercase characters you enter are converted to uppercase.
Embedded blanks are not acceptable and a name consisting entirely of blanks is treated as though no Poolname had been supplied.

You cannot specify POOLNAME if REMOTESYSTEM is also specified.

Note: CICS does not search for a matching TSMODEL if an application program specifies a SYSID on the EXEC CICS temporary storage command, or if a SYSID is added by an XTSEREQ global user exit program. To enable CICS to find the name of a temporary storage data sharing pool when the application program explicitly specifies a SYSID, you need to use a TST with a suitable TYPE=SHARED entry. See CICS Operations and Utilities Guide for more information about migrating a TST with TYPE=SHARED entries.
PREFIX(prefix)
specifies the character string that is to be used as the prefix for this model. The prefix may be up to 16 characters in length.
Acceptable characters:
A-Z a-z 0-9 $ @ # . / - _ % & ¢ ? ! : | " = ¬ , ; < >
For information about entering mixed case information, see Entering mixed case attributes.
You can specify generic values for the PREFIX attribute. To specify a generic value, use the following wildcard character:
+
Matches exactly one character. You can use the wildcard character one or more times in the PREFIX attribute.
For example:
  • ABC+ matches ABCD and ABCE, but not ABC or ABDE
  • P++S matches PQRS, but not PQS or PQRSS

Start of changeCreating a TSMODEL definition with a blank prefix can produce unexpected results. A TSMODEL definition with a blank prefix matches any queue name that is not matched by any other TSMODEL definition.End of change

Note: Start of changeTo enable CICS to find the name of a temporary storage data sharing pool when the application program explicitly specifies a SYSID, you need to use a TST with a suitable TYPE=SHARED entry. See CICS Operations and Utilities Guide for more information about migrating a TST with TYPE=SHARED entries.End of change
RECOVERY({NO|YES})
specifies whether or not queues matching this model are to be recoverable.
NO
queues matching this model are to be non-recoverable.
YES
queues matching this model are to be recoverable.

RECOVERY(YES) is not allowed with LOCATION(MAIN).

REMOTEPREFIX(prefix)
specifies the character string that is to be used as the prefix on the remote system. The prefix may be up to 16 characters in length.
Acceptable characters:
A-Z a-z 0-9 $ @ # . / - _ % & ¢ ? ! : | " = ¬ , ; < >
For information about entering mixed case information, see Entering mixed case attributes.
You can specify generic values for the REMOTEPREFIX attribute. To specify a generic value, use the following wildcard character:
+
Matches exactly one character. You can use the wildcard character one or more times in the PREFIX attribute.
For example:
  • ABC+ matches ABCD and ABCE, but not ABC or ABDE
  • P++S matches PQRS, but not PQS or PQRSS

REMOTEPREFIX is not allowed unless REMOTESYSTEM is also specified.

If REMOTEPREFIX is specified:
  • Its length must be the same as the length of Prefix.
  • If wild characters are used, they must be in the same position in Prefix and Remoteprefix as in the following example:
         Prefix:        A++D
         Remoteprefix:  X++Y
REMOTESYSTEM(connection)
specifies the name of the connection that links the local system to the remote system where the temporary storage queue resides.
Acceptable characters:
A-Z 0-9 $ @ #
Unless you are using the CREATE command, any lowercase characters you enter are converted to uppercase.
Embedded blanks are not acceptable and a name consisting entirely of blanks is treated as though no Remotesystem had been specified.

REMOTESYSTEM and POOLNAME are mutually exclusive. If REMOTESYSTEM is specified, POOLNAME is ignored.

SECURITY({NO|YES})
specifies whether security checking is to be performed for queues matching this model.
NO
security checking is not to be performed for queues matching this model.
YES
security checking is to be performed for queues matching this model.
For more information, see the CICS RACF® Security Guide.
TSMODEL(name)
specifies the name of this TSMODEL definition. The name can be up to eight characters in length.
Acceptable characters:
A-Z a-z 0-9 $ @ # . / - _ % & ¢ ? ! : | " = ¬ , ; < >
For information about entering mixed case information, see Entering mixed case attributes.
Embedded blanks are not acceptable.

This name is used to identify the TSMODEL definition on the CSD file. It is not used within the active CICS system.

XPREFIX(xprefix)
may be used as an alternative to PREFIX. Enter a hexadecimal string, up to 32-characters in length, that is to be used as the prefix for this model. Because XPREFIX is specified in hexadecimal form, you can use a name that contains characters that you cannot enter in the PREFIX attribute.
You can specify generic values for the XPREFIX attribute. To specify a generic value, use the following wildcard character:
X'4E'
Matches exactly one character. You can use the wildcard character one or more times in the XPREFIX attribute.
XREMOTEPFX(xprefix)
may be used as an alternative to REMOTEPREFIX. Enter a hexadecimal string, up to 32-characters in length, that is to be used as the prefix on the remote system. Because XREMOTEPREFIX is specified in hexadecimal form, you can use a name that contains characters that you cannot enter in the REMOTEPREFIX attribute.
You can specify generic values for the XREMOTEPREFIX attribute. To specify a generic value, use the following wildcard character:
X'4E'
Matches exactly one character. You can use the wildcard character one or more times in the XPREFIX attribute.