PIPELINE attributes

Describes the syntax and attributes of the PIPELINE resource.

Read syntax diagramSkip visual syntax diagramPIPELINE( name)GROUP( groupname)DESCRIPTION( text)CONFIGFILE( name)SHELF(/var/cicsts)SHELF( directory)STATUS(ENABLED)STATUS(DISABLED)RESPWAIT(DEFT)RESPWAIT( value)WSDIR( directory)
CONFIGFILE(name)
Specifies the fully qualified or relative name of a z/OS® UNIX file that contains information about the processing nodes that will act on a service request, and on the response.Start of change
  • For a configuration file for a PIPELINE resource defined by online resource definition, the file path is either fully qualified, if prefixed with a forward slash (/), or is relative to the HOME directory of the CICS region user ID.
  • For a configuration file for a PIPELINE resource defined in a CICS bundle, the file path is relative to the root directory of the CICS bundle. The zFS file must be packaged in the CICS bundle with the PIPELINE resource. For more information, see Referencing zFS artifacts in a bundle.
End of change
The value specified must be a valid name for a UNIX file:
  • It must not contain imbedded space characters.
  • It must not contain consecutive instances of the / character.
  • It is case-sensitive.
Acceptable characters:
A-Z a-z 0-9 . / _ # @ -
DESCRIPTION(text)
You can provide a description of the resource that you are defining in this field. The description text can be up to 58 characters in length. No restrictions apply to 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 lowercase characters that you enter are converted to uppercase.

The GROUP name can be up to 8 characters in length. Lowercase characters are treated as uppercase characters.

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 that you enter are converted to uppercase.
RESPWAIT(value)
Specifies the number of seconds that an application program should wait for a response message from a remote web service. The value can range from 0 to 9999 seconds.
To use the default timeout value of the transport protocol, specify DEFT. The default timeout value is also used if you do not specify any value for RESPWAIT.
  • The default timeout value for HTTP is 10 seconds.
  • The default timeout value for WebSphere® MQ is 60 seconds.
SHELF({/var/cicsts/|directory})
Specifies the 1–255 character fully-qualified name of a directory (a shelf, primarily for web service binding files) on z/OS UNIX.
The value specified must be a valid name for a UNIX file:
  • It must not contain imbedded space characters.
  • It must not contain consecutive instances of the / character.
  • It is case-sensitive.
Acceptable characters:
A-Z a-z 0-9 . / _ # @ -

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.

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.

Start of changeA PIPELINE resource that is defined in a CICS bundle using CICS Explorer® does not use a shelf directory.End of change

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 z/OS UNIX. Each PIPELINE installed in a CICS region must specify a different web service binding directory.
The value specified must be a valid name for a UNIX file:
  • It must not contain imbedded space characters.
  • It must not contain consecutive instances of the / character.
  • It is case-sensitive.
Acceptable characters:
A-Z a-z 0-9 . / _ # @ -

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 z/OS UNIX 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.