PIPELINE attributes

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

                     .-SHELF(/var/cicsts)-.   
>--CONFIGFILE(name)--+--------------------+--------------------->
                     '-SHELF(directory)---'   

   .-STATUS(ENABLED)--.                         
>--+------------------+--+------------------+------------------><
   '-STATUS(DISABLED)-'  '-WSDIR(directory)-'   

PIPELINE(name)
Specifies the name of this PIPELINE. The name can be up to eight characters in length.
Acceptable characters:
A-Z 0-9 $ @ #
Unless you are using the CREATE command, any lowercase characters you enter are converted to uppercase.
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.

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.
CONFIGFILE(name)
Specifies the name of an HFS file that contains information about the processing nodes that will act on a service request, and on the response.Start of change
Acceptable characters:
A-Z a-z 0-9 . / _ # @
For information about entering mixed case information, see Entering mixed case attributes.
End of change
The value specified must be a valid name for an HFS file:
  • The name must not contain imbedded space characters
  • The name must not contain consecutive instances of the / character
The name is case-sensitive.
SHELF({/var/cicsts/|directory})
Specifies the 1–255 character fully-qualified name of a directory (a shelf, primarily for Web service binding files) on HFS. Start of change
Acceptable characters:
A-Z a-z 0-9 . / _ # @
For information about entering mixed case information, see Entering mixed case attributes.
End of change
The value specified must be a valid name for an HFS file:
  • The name must not contain imbedded space characters
  • The name must not contain consecutive instances of the / character
The name is case-sensitive.

CICS regions into which the PIPELINE definition is installed must have full permissions to the shelf directory—read, write, and the ability to create subdirectories.

A single shelf directory can be shared by multiple CICS regions and by multiple PIPELINE definitions. Within a shelf directory, each CICS region uses a separate subdirectory to keep its files separate from those of other CICS regions. Within each region's directory, each PIPELINE uses a separate subdirectory.

After a CICS region performs a cold or initial start, it deletes its subdirectories from the shelf before trying to use the shelf.

You should not attempt to modify the contents of a shelf that is referred to by an installed PIPELINE definition. If you do, the effects are unpredictable.

STATUS({ENABLED|DISABLED})
Specifies the initial status of the PIPELINE when it is installed:
ENABLED
Web service requests for this PIPELINE are processed normally.
DISABLED
Web service requests for this PIPELINE cannot be processed.
WSDIR(directory)
specifies the 1–255 character fully-qualified name of the Web service binding directory (also known as the pickup directory) on HFS. Start of change
Acceptable characters:
A-Z a-z 0-9 . / _ # @
For information about entering mixed case information, see Entering mixed case attributes.
End of change
The value specified must be a valid name for an HFS file:
  • The name must not contain imbedded space characters
  • The name must not contain consecutive instances of the / character
The name is case-sensitive.

The Web service binding directory contains Web service binding files that are associated with a PIPELINE, and that are to be installed automatically by the CICS scanning mechanism. When the PIPELINE definition is installed, CICS scans the directory and automatically installs any Web service binding files it finds there. Note that this happens regardless of whether the PIPELINE is installed in enabled or disabled state.

If you specify a value for the WSDIR attribute, it must refer to a valid HFS directory to which the CICS region has at least read access. If this is not the case, any attempt to install the PIPELINE resource will fail.

If you do not specify a value for WSDIR, no automatic scan takes place on installation of the PIPELINE, and PERFORM PIPELINE SCAN commands will fail.