CICSplex Web Service Details attribute group

The CICSplex Web Service Details attribute group retrieves information about an installed WEBSERVICE resource.

Average Request Body Length The current average request body length for the Web Service requests. The value format is a positive integer, maximum four bytes.

Average Response Body Length The current average response body length for the Web Service requests. The value format is a positive integer, maximum four bytes.

Average Response Time The current average response time for the Web Service requests in milliseconds. The value format is a positive integer, maximum four bytes.

Average Total Body Length The current average total request and response body lengths for the Web Service requests. The value format is a positive integer, maximum four bytes.

Binding Is the WSDL binding string represented by the WEBSERVICE attribute. This binding is one of (potentially) many listed in the WSDL file. The name is up to 255 characters in length.

CCSID Is the Coded Character Set Identifier used to encode data between the application program and the web service binding file shown at runtime. The value is an integer with a maximum of four characters.

CICS Region Name Is the job name or modify ID of the CICS region being monitored. Each CICS region in a z/OS operating system has a unique name. This name is an alphanumeric string, with a maximum of eight characters, and case-sensitive. CICS region names are always in uppercase characters.

CICS Version Is the version number of the CICS region. This number is an alphanumeric string, with a maximum of four characters.

Current Fault Percent The percentage of the current requests that had a fault associated with them. The value format is an integer with a maximum of two characters.

Current Request Rate The number of requests per minute in the last one to two minute span. The value format is an integer with a maximum of two characters.

Current Timeout Percent The percentage of the current requests that had a timeout associated with them. The value format is an integer with a maximum of two characters.

Container Name Is the name of the container used if PGMINTERFACE resource returns a value of CHANNEL. The name is up to 16 characters in length.

Direct XOP Supported Shows if the web service can handle Direct XML-binary Optimized Packaging (XOP) Supported documents. These are the values:

YES

Direct XOP supported.

NO

Direct XOP not supported.

Endpoint Is the endpoint URI of a remote WEBSERVICE. This endpoint is specified in the WSDL file for a remote web service. If a CICS application program is the service provider, then the ENDPOINT is empty. The URI is up to 255 characters in length.

HWM of Request Body Length The high water mark of the current request body length for a Web Service request. The value format is a positive integer, maximum four bytes.

HWM of Response Body Length The high water mark of the current response body length for a Web Service request. The value format is a positive integer, maximum four bytes.

HWM of Response Time The high water mark of the current response time for a Web Service request in milliseconds. The value format is a positive integer, maximum four bytes.

HWM of Total Body Length The high water mark of the current total request and response body lengths for a Web Service request. The value format is a positive integer, maximum four bytes.

Last Modified Is the timestamp of the latest modification. This is defined in milliseconds since 00:00 on January 1st 1900, that the deployed WSBind file on HFS was last updated. This is a read only value that CICS updates when the WEBSERVICE resource is installed or updated. The last-modified-time can be used to determine whether CICS has refreshed itself after an update is made to a WSBind file in the pickup directory.

Mapping Level Is used to convert data between language structures and the Web Services Description Language (WSDL) documents. This name is up to eight characters in length.

Mapping Level Release Is the release number for the mapping level used to convert data between language structures and Web Services Description Language (WSDL) documents. The release number is an integer with a maximum of four characters.

Mapping Level Version Is the version number for the mapping level that is used to convert data between language structures and the web service description language documents. The version number is an integer with a maximum of four characters.

Origin Node Is the combination of z/OS System ID (SMFID) and CICS region name. The value format is an alphanumeric string, maximum 32 bytes, and case-sensitive.

When a situation is true, the system compares the origin node name in the attribute to the names of managed systems assigned to the item. If the origin node name matches the name of a managed system, the status of the item changes accordingly. If the names of the origin node and the managed systems do not match, the status of the item remains unchanged.

Pipeline Name Is the name of the PIPELINE in which the WEBSERVICE is installed. That is, the name of the PIPELINE resource that contains this WEBSERVICE resource. The name is up to eight characters in length.

Program Interface Indicates whether the CICS program that implements the web service expects input in a channel or in a COMMAREA. These are the values:

CHANNEL

The program expects input in a channel.

COMMAREA

The program expects input in a CICS common area.

n/a

The program does not expect input.

Program Name Is the name of a CICS program that implements the web service. If this WEBSERVICE represents a remote web service (for example, CICS is not the service provider), the PROGRAM is empty. The name can be up to eight characters in length.

Required Runtime Level Is the minimum runtime level required to run the web service in CICS. This name can be up to eight characters in length.

Required Runtime Release Is the release number for the minimum runtime level required to run the web service in CICS. The value is an integer up to four characters in length.

Required Runtime Version Is the version number for the minimum runtime level required to run the web service in CICS. The value is an integer up to four characters in length.

Status Is the one-character name that shows the current web status. These are the values:

DISCARDING

A DISCARD command has been issued for the WEBSERVICE. The WEBSERVICE is quiescing before being discarded. It is not accepting new work, but is allowing currently-executing work to complete.

INITING

The web service binding file, and the WSDL file, are being copied to the shelf.

INSERVICE

Resolution of the copy of the WSBIND file on the shelf has succeeded, and the WEBSERBICE is usable.

UNUSABLE

Copying of the WSBIND file on the shelf has failed, and the WEBSERVICE is unusable.

System ID Is the four character name that uniquely identifies an active z/OS operating system within a given CICSplex. The value format is an alphanumeric string, maximum four characters, and case-sensitive. z/OS System IDs are always in uppercase characters.

Total Number of Faults The total number of requests with an associated fault since the statistics were reset. The value format is a positive integer, maximum four bytes.

Total Number of Timeouts The total number of requests which have timed out since the statistics were reset. The value format is a positive integer, maximum four bytes.

Type Indicates whether CICS is the provider of the web service or the requester of the web service. The value is a single character that can either be P for provider or R for requestor.

Use Count Is the usage count for the current web Service. The value format is an integer, maximum four characters.

URIMAP Name Is the name of a dynamically installed URIMAP. The value format is an alphanumeric string, maximum eight characters. A URIMAP is used to define the URL formats used to access your CICS system with CICS web support. They allow you to mask the CICS resources being used from the end users. They also allow both dynamic and static content to easily be returned.

Validation Indicator Shows whether full validation of SOAP messages is currently enabled for this WEBSERVICE. These are the values:

YES

Full validation is enabled.

NO

Full validation is disabled.

Web Service Name The name of the WEBSERVICE resource. The value format is an alphanumeric string, maximum 32 characters.

WS Bind File The name of the web service binding file. The name can be up to 255 characters in length.

WS Description File The name of the web service description file associated with the WEBSERVICE resource. The name can be up to 255 characters in length.

XOP Supported Shows whether or not the web service implementation can handle XOP documents and binary attachments in direct mode. These are the values:

YES

XOP supported

NO

XOP not supported